instagram-data
v1.1.0
Published
Wrapper for Instagram GDPR data export
Downloads
8
Maintainers
Readme
Instagram Data
Instagram Data is a wrapper for Instagram's GDPR data export. It provides a convenient way to interact with the data provided by Instagram.
Installation
To install the package, you can use npm or yarn:
$ npm install instagram-data
or
$ yarn add instagram-data
Usage
First, import the InstagramData class from the package:
import InstagramData from 'instagram-data';
Then, you can create an instance of the class and initialize it with a file:
const instagramData = new InstagramData();
instagramData.init(file);
The init method is asynchronous and needs to be awaited. It takes a File
object, which should be the zipped data export provided by Instagram.
API
The InstagramData class provides the following properties:
- followers: An array of relationships representing the followers of the user.
- following: An array of relationships representing the users that the user is following.
Each relationship object has the following properties:
- username: The username of the user in the relationship.
- timestamp: The timestamp of when the relationship was established.
Building
To build the package, you can use the build script in the package.json file:
npm run build
This will compile the TypeScript code to JavaScript and output it to the dist
directory.
License
This package is licensed under the MIT License. For more details, see the LICENSE file.