Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d4nyll/instafetch
Hack the count limit Instagram imposes in its API
https://github.com/d4nyll/instafetch
instagram instagram-api
Last synced: about 1 month ago
JSON representation
Hack the count limit Instagram imposes in its API
- Host: GitHub
- URL: https://github.com/d4nyll/instafetch
- Owner: d4nyll
- License: mit
- Created: 2015-01-22T07:57:54.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-05T13:42:07.000Z (about 6 years ago)
- Last Synced: 2024-03-02T23:35:17.082Z (10 months ago)
- Topics: instagram, instagram-api
- Language: JavaScript
- Size: 16.6 KB
- Stars: 46
- Watchers: 6
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# instafetch
[](https://gitter.im/d4nyll/instafetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Fetch Instagram media without limit
## [Demo](http://d4nyll.github.io/instafetch/)
# What it does
instafetch fetches media from Instagram based on (and only on) the **user and/or tag**, relying on the Instagram API.
If you use the Instagram API to make a call, you will only get 33 results back, no matter what you specify in the `count` paramter. Instafetch will help you fetch more media than the limit imposes, in exchange for more API calls, which can count against your hourly limit.
# How to Use
> instafetch requires [jQuery](http://jquery.com/), which you can download [here](http://jquery.com/download/).
You can find an example in `examples/example.html`
1. Include jQuery, followed by instafetch
2. Write a function to be passed into the fetcher, all your logic should be written here. For example, you may want to use the params to specify the `id` of a `div` to which you will insert the media into
3. Create an instance of a fetcher by passing in your client ID. (You must have an instagram developer's account, you can get one [here](http://instagram.com/developer))
4. Use your fetcher to fetch media. A single fetcher can be used in more than one fetch.
```js
$(function() {
// Create a callback that simply logs the response and parameters
var displayInstaBlocks = function(response, params) {
console.log(response);
console.log(params);
};
// Get an instance of a fetcher
var fetcher = new Instafetch('[--ACCESS TOKEN--]');
// Fetch results
fetcher.fetch({
user: [--USER ID--],
tag: [--TAG NAME--],
limit: 88,
callback: displayInstaBlocks,
params: 'instafeed'
});
});
```
## Options
| option | Type | description | Required? |
|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| user | int | The ID of the user whose media you are fetching | At least one of `user` or `tag` is required |
| tag | string | A single tag | At least one of `user` or `tag` is required |
| maxId | string | If specified, instafetch will only fetch media older than the media with this ID | No |
| callback | function | Create a function and pass it (without `()`) into the fetcher. This will be called once the results are ready. It should accept two arguments - the first is the response object from the fetch, and the second are the arguments passed in from the `params` property. | Yes |
| params | object | An object that will be passed into the callback. | |
## Coming soon...
We will provide more template callbacks so you can just plug-and-play. All the provided template callbacks shall have a `params` object with the following properties:
* width
* height
* scale (cover, crop)
* resolution (thumbnail, low, standard)
* class