{"id":24973375,"url":"https://github.com/shitgram/node-shitgram","last_synced_at":"2025-04-11T08:43:58.402Z","repository":{"id":57358564,"uuid":"210215353","full_name":"shitgram/node-shitgram","owner":"shitgram","description":"A JavaScript library to make requests to Instagram","archived":false,"fork":false,"pushed_at":"2020-03-27T18:54:49.000Z","size":45,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-02-22T22:46:50.448Z","etag":null,"topics":["albums","highlights","images","insta","instagram","javascript","nodejs","plugins","promise","scrap","sessionid","shitgram","stories","users","videos"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shitgram.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-22T21:16:23.000Z","updated_at":"2022-12-02T17:48:16.000Z","dependencies_parsed_at":"2022-09-06T21:41:21.411Z","dependency_job_id":null,"html_url":"https://github.com/shitgram/node-shitgram","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shitgram%2Fnode-shitgram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shitgram%2Fnode-shitgram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shitgram%2Fnode-shitgram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shitgram%2Fnode-shitgram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shitgram","download_url":"https://codeload.github.com/shitgram/node-shitgram/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248362626,"owners_count":21091168,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["albums","highlights","images","insta","instagram","javascript","nodejs","plugins","promise","scrap","sessionid","shitgram","stories","users","videos"],"created_at":"2025-02-03T18:58:57.911Z","updated_at":"2025-04-11T08:43:58.362Z","avatar_url":"https://github.com/shitgram.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://a.kyouko.se/eUhh.png\" width=\"200\" height=\"200\"\u003e\u003cbr\u003e\n\t\u003cb\u003eA JavaScript library to make requests to Instagram\u003c/b\u003e\n\t\u003cbr\u003e\u003cbr\u003e\n\t\u003ca href=\"https://npmjs.com/package/shitgram\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/shitgram?style=flat-square\" alt=\"Version\"\u003e\u003c/a\u003e\n\t\u003cimg src=\"https://img.shields.io/node/v/shitgram?style=flat-square\" alt=\"Node\"\u003e\n\t\u003cimg src=\"https://img.shields.io/david/shitgram/node-shitgram?style=flat-square\" alt=\"Dependencies\"\u003e\n\t\u003ca href=\"https://github.com/shitgram/node-shitgram/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/shitgram/node-shitgram?style=flat-square\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Contents\n\n- [Installation](#installation)\n- [Example](#example)\n- [Documentation](#documentation)\n- [Plugins](#plugins)\n\n## Installation\n\n```\n$ yarn add shitgram\n```\n\n## Example\n\n```js\nconst Shitgram = require('shitgram');\n\nconst shitgram = new Shitgram();\n\nshitgram.user('tenasatupitsyn')\n\t.then((data) =\u003e {\n\t\t// Handle success\n\t\tconsole.log(data);\n\n\t\t/*\n\t\t\t{\tid: '7661979279',\n\t\t\t \turl: 'https://www.instagram.com/tenasatupitsyn',\n\t\t\t \tavatarURL: 'https://instagram.frec8-1.fna.fbcdn.net/vp/d5...',\n\t\t\t\tisPrivate: false,\n\t\t\t\tisVerified: false,\n\t\t\t\tisBusiness: true,\n\t\t\t\tbusinessCategory: 'Creators \u0026 Celebrities',\n\t\t\t\tusername: 'tenasatupitsyn',\n\t\t\t\tfullName: 'Tenasa M. Tupitsyn',\n\t\t\t\tbiography: 'YuGi TeNaSa 1010.\\nLara/VE 🇻🇪',\n\t\t\t\temail: null,\n\t\t\t\twebsite: null,\n\t\t\t\tfollowers: 0,\n\t\t\t\tfollowing: 0,\n\t\t\t\tposts: 0\t}\n\t\t */\n\n\t})\n\t.catch((error) =\u003e {\n\t\t// Handle error\n\t\tconsole.log(error);\n\t});\n```\n\n## Documentation\n\n### new Shitgram(credentials) ⇒ [Constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor)\n\n- **`credentials`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `username` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Instagram account username\n\t- `password` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Instagram account password\n\t- `sessionID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; An instagram session id. Will be used if you have not set `username` and `password`.\n\nYou will not need to set a session id if you have already set username and password.\n\n### getSessionID ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGenerate a new session id or return a defined sessionID\n\nIf username and password are set, a new session id will always be generated. So that a unique session id will be returned set property sessionID in the credentials.\n\nIt is possible to get the session ID without the builder by using [plug-in](#plugins).\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e —  Session id generated or returning from credentials\n\n### getUserDataWithSession(userID, sessionID) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet user data that is only available with a session id\n\n- `userID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n- `sessionID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User data obtained only in session\n\n### getUserStoriesWithSession(userID, sessionID) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet user stories that is only available with a session id\n\n- `userID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n- `sessionID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User story data obtained in one session only\n\n### getUserHighlightsWithSession(userID, sessionID) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet user highlight that is only available with a session id\n\n- `userID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n- `sessionID` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User Highlight data obtained in one session only\n\n### user(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet user details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; `Username` or `link` for the user profile you want details about\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return instagram default response, `false` is set to default.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User data\n\n### story(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet story details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; `Username` or `link` for the user stories you want details about\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return default response from storiesig.com or if you have set credentials the response will be from instagram.com, `false` is set to default.\n\t- `exclude` : [ExcludeType](#excludetype--enumstring)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; The file type to [exclude](https://github.com/shitgram/node-shitgram/blob/master/enums/EExcludeType.js) from the response, will not exclude if **defaultResponse** is `true`.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User story data\n\n### highlight(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet highlight details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; `Highlight id` or `link` to it\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return instagram default response, `false` is set to default.\n\t- `exclude` : [ExcludeType](#excludetype--enumstring)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; The file type to [exclude](https://github.com/shitgram/node-shitgram/blob/master/enums/EExcludeType.js) from the response, will not exclude if **defaultResponse** is `true`.\n\nHighlights will be returned if they have been set by the author to be shared, check availability of highlights in the `canReshare` property; if null, highlights will be an empty array.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  User highlight data\n\n### image(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet image post details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; `Post code` or `link` to it\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return instagram default response, `false` is set to default.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  Image data\n\n### video(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet video post details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; `Post code` or `link` to it\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return instagram default response, `false` is set to default.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  Video data\n\n### album(param[, options]) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGet album post details\n\n- **`param`** : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Album `post code` or `link` to it\n- **`options`** : [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) _(Optional)_\n\t- `defaultResponse` : [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Set `true` to return instagram default response, `false` is set to default.\n\t- `exclude` : [ExcludeType](#excludetype--enumstring)\u003cbr\u003e\n\t\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; The file type to [exclude](https://github.com/shitgram/node-shitgram/blob/master/enums/EExcludeType.js) from the response, will not exclude if **defaultResponse** is `true`.\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  Album data\n\n### ExcludeType : _enum\u003c[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e_\nFile type to exclude from response\n\nAvailable properties: `IMAGE` - `VIDEO`\n\n## Plugins\n\n### Session(username, password) ⇒ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nGenerate a new csrfToken and sessionID from Instagram username and password\n\n- `username` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Instagram account username\n- `password` : [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) _(Required)_\u003cbr\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; Instagram account password\n\nA brief example of use [here](https://github.com/shitgram/node-shitgram/blob/master/examples/generate_session.example.js)\n\n**Returns**: \u0026nbsp;\u0026nbsp; [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\u003c[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e —  New session info\n\n\u003cp align=\"center\"\u003e\n\t\u003ca href=\"#readme\"\u003eBACK TO TOP\u003c/a\u003e\n\u003c/p\u003e","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshitgram%2Fnode-shitgram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshitgram%2Fnode-shitgram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshitgram%2Fnode-shitgram/lists"}