nodestagram

0.1.1 • Public • Published

Nodestagram

FORK VERSION 2016 - Bugs solved

This project started because I wanted to use instagram's API in node.js and there were no libraries yet.

Since everything is so fresh spanking new, forks/pull-requests much appreciated.

Usage

The library is intended to be used as a thin wrapper over the basic Instagram API, so the idea is to keep everything as similar to the original as possible.

Every method should be passed some parameters if needed and a callback function. The callback should accept a result and an error argument.

The convention being that when the error is null, the result contains media as returnd from the API, and when something goes wrong error is the status code as returned by the API and the result is the meta info the API returned.

For example:

var instagram = require('instagram').createClient('<client_id>', '<client_secret>');

// fetch media by id
instagram.media.id('<id>', function (images, error) { ... });

// fetch popular media
instagram.media.popular(function (images, error) { ... });

// search media
instagram.media.popular({lat: <some latitude>,
		             lng: <some longitude>},
		    function (images, error) { ... });


// get info about a tag
instagram.tags.tag('snow', function (tag, error) { ... });

// get recent media for a tag
instagram.tags.media('snow', function (tag, error) { ... });
instagram.tags.media('snow', {max_id: 5}, function (tag, error) { ... });
instagram.tags.media('snow', {min_id: 5}, function (tag, error) { ... });
instagram.tags.media('snow', {max_id: 5, min_id: 0}, function (tag, error) { ... });

// search for a tag
instagram.tags.search('snow', function (tags, error) { ... });


// get info about a location
instagram.tags.tag(1, function (tag, error) { ... });

// get recent media for a location
instagram.tags.media(1, function (tag, error) { ... });
instagram.tags.media(1, {max_id: 5}, function (tag, error) { ... });
instagram.tags.media(1, {min_id: 5}, function (tag, error) { ... });
instagram.tags.media(1, {max_id: 5, min_id: 0}, function (tag, error) { ... });

// search for a location
instagram.tags.search({lat: ..., lng: ..., distance: ...}, function (tags, error) { ... });


// get info about a specific user
instagram.users.id(1234, function (user, error) { ... });

// get recent media for a user
instagram.users.media(1234, {count: 12}, function (images, error, pagination) { ... });

// getting own media, according to given *access_token* which is a required parameter
instagram.users.self({access_token: "1337", count: 12}, function (images, error, pagination) { ... });

// search for usernames
instagram.users.search("Jack", function (users, error) { ... });
instagram.users.search({q: "John", count: 1}, function (users, error) { ... });

License

Some sort of BSD or MIT license, the general idea being:

  • this is open source
  • you must give credit where credit is due
  • not viral such as GPL
  • you still can't change the license though

Readme

Keywords

none

Package Sidebar

Install

npm i nodestagram

Weekly Downloads

1

Version

0.1.1

License

none

Last publish

Collaborators

  • josep