This project is not actively maintained. Proceed at your own risk!
A Ruby wrapper for the Instagram REST and Search APIs
gem install instagram
Our developer site documents all the Instagram REST and Search APIs.
The [Developer Blog] features news and important announcements about the Instagram Platform. You will also find tutorials and best practices to help you build great platform integrations. Make sure to subscribe to the RSS feed not to miss out on new posts: http://developers.instagram.com.
The Stack Overflow community is a great place to ask API related questions or if you need help with your code. Make sure to tag your questions with the Instagram tag to get fast answers from other fellow developers and members of the Instagram team.
Add it to the apps wiki!
require"sinatra"require"instagram"enable:sessionsCALLBACK_URL="http://localhost:4567/oauth/callback"Instagram.configuredo |config|
config.client_id="YOUR_CLIENT_ID"config.client_secret="YOUR_CLIENT_SECRET"# For secured endpoints only#config.client_ips = '<Comma separated list of IPs>'endget"/"do'<a href="/oauth/connect">Connect with Instagram</a>'endget"/oauth/connect"doredirectInstagram.authorize_url(:redirect_uri=>CALLBACK_URL)endget"/oauth/callback"doresponse=Instagram.get_access_token(params[:code],:redirect_uri=>CALLBACK_URL)session[:access_token]=response.access_tokenredirect"/nav"endget"/nav"dohtml=""" <h1>Ruby Instagram Gem Sample Application</h1> <ol> <li><a href='/user_recent_media'>User Recent Media</a> Calls user_recent_media - Get a list of a user's most recent media</li> <li><a href='/user_media_feed'>User Media Feed</a> Calls user_media_feed - Get the currently authenticated user's media feed uses pagination</li> <li><a href='/location_recent_media'>Location Recent Media</a> Calls location_recent_media - Get a list of recent media at a given location, in this case, the Instagram office</li> <li><a href='/media_search'>Media Search</a> Calls media_search - Get a list of media close to a given latitude and longitude</li> <li><a href='/media_popular'>Popular Media</a> Calls media_popular - Get a list of the overall most popular media items</li> <li><a href='/user_search'>User Search</a> Calls user_search - Search for users on instagram, by name or username</li> <li><a href='/location_search'>Location Search</a> Calls location_search - Search for a location by lat/lng</li> <li><a href='/location_search_4square'>Location Search - 4Square</a> Calls location_search - Search for a location by Fousquare ID (v2)</li> <li><a href='/tags'>Tags</a>Search for tags, view tag info and get media by tag</li> <li><a href='/limits'>View Rate Limit and Remaining API calls</a>View remaining and ratelimit info.</li> </ol> """htmlendget"/user_recent_media"doclient=Instagram.client(:access_token=>session[:access_token])user=client.userhtml="<h1>#{user.username}'s recent media</h1>"formedia_iteminclient.user_recent_mediahtml << "<div style='float:left;'><img src='#{media_item.images.thumbnail.url}'><br/> <a href='/media_like/#{media_item.id}'>Like</a> <a href='/media_unlike/#{media_item.id}'>Un-Like</a> <br/>LikesCount=#{media_item.likes[:count]}</div>"endhtmlendget'/media_like/:id'doclient=Instagram.client(:access_token=>session[:access_token])client.like_media("#{params[:id]}")redirect"/user_recent_media"endget'/media_unlike/:id'doclient=Instagram.client(:access_token=>session[:access_token])client.unlike_media("#{params[:id]}")redirect"/user_recent_media"endget"/user_media_feed"doclient=Instagram.client(:access_token=>session[:access_token])user=client.userhtml="<h1>#{user.username}'s media feed</h1>"page_1=client.user_media_feed(777)page_2_max_id=page_1.pagination.next_max_idpage_2=client.user_recent_media(777,:max_id=>page_2_max_id)unlesspage_2_max_id.nil?html << "<h2>Page 1</h2><br/>"formedia_iteminpage_1html << "<img src='#{media_item.images.thumbnail.url}'>"endhtml << "<h2>Page 2</h2><br/>"formedia_iteminpage_2html << "<img src='#{media_item.images.thumbnail.url}'>"endhtmlendget"/location_recent_media"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Media from the Instagram Office</h1>"formedia_iteminclient.location_recent_media(514276)html << "<img src='#{media_item.images.thumbnail.url}'>"endhtmlendget"/media_search"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Get a list of media close to a given latitude and longitude</h1>"formedia_iteminclient.media_search("37.7808851","-122.3948632")html << "<img src='#{media_item.images.thumbnail.url}'>"endhtmlendget"/media_popular"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Get a list of the overall most popular media items</h1>"formedia_iteminclient.media_popularhtml << "<img src='#{media_item.images.thumbnail.url}'>"endhtmlendget"/user_search"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Search for users on instagram, by name or usernames</h1>"foruserinclient.user_search("instagram")html << "<li> <img src='#{user.profile_picture}'> #{user.username}#{user.full_name}</li>"endhtmlendget"/location_search"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Search for a location by lat/lng with a radius of 5000m</h1>"forlocationinclient.location_search("48.858844","2.294351","5000")html << "<li> #{location.name} <a href='https://www.google.com/maps/preview/@#{location.latitude},#{location.longitude},19z'>Map</a></li>"endhtmlendget"/location_search_4square"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Search for a location by Fousquare ID (v2)</h1>"forlocationinclient.location_search("3fd66200f964a520c5f11ee3")html << "<li> #{location.name} <a href='https://www.google.com/maps/preview/@#{location.latitude},#{location.longitude},19z'>Map</a></li>"endhtmlendget"/tags"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1>Search for tags, get tag info and get media by tag</h1>"tags=client.tag_search('cat')html << "<h2>Tag Name = #{tags[0].name}. Media Count = #{tags[0].media_count}. </h2><br/><br/>"formedia_iteminclient.tag_recent_media(tags[0].name)html << "<img src='#{media_item.images.thumbnail.url}'>"endhtmlendget"/limits"doclient=Instagram.client(:access_token=>session[:access_token])html="<h1/>View API Rate Limit and calls remaining</h1>"response=client.utils_raw_responsehtml << "Rate Limit = #{response.headers[:x_ratelimit_limit]}. <br/>Calls Remaining = #{response.headers[:x_ratelimit_remaining]}"htmlendIn the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by closing issues
- by reviewing patches
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
Instagram has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
- Fork the project.
- Create a topic branch.
- Implement your feature or bug fix.
- Add documentation for your feature or bug fix.
- Run rake doc:yard. If your changes are not 100% documented, go back to step 4.
- Add specs for your feature or bug fix.
- Run rake spec. If your changes are not 100% covered, go back to step 6.
- Commit and push your changes.
- Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
- If you haven't already, complete the Contributor License Agreement ("CLA").
Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Instagram's or Facebook's open source projects.
Complete your CLA here: https://code.facebook.com/cla
Copyright (c) 2014, Facebook, Inc. All rights reserved. By contributing to Instagram Ruby Gem, you agree that your contributions will be licensed under its BSD license. See LICENSE for details.