instagrapi

Instagrapi

Library to obtain information from an Instagram account in a friendly and intuitive way.

The library works as a wrapper for the basic Instagram API, to abstract long or confusing property names and have a clean and readable data structure.

Created with NodeJS and Typescript, all types are exposed for use. + 💗

🌐 Demo website ➜

Installation

• NPM

npm install instagrapi

• CDN

<!-- Bundle minify and optimized to production -->
<script src="https://cdn.jsdelivr.net/npm/instagrapi@3/dist/bundle/instagrapi.min.js"></script>

• DOWNLOAD

Download the bundle from jsdelivr selecting the instagrapi.min.js file and then right click "save as".

Usage

First you must get the cookie called "sessionId" by logging in to your instagram account. To do this you must follow these steps:

1. Go to https://www.instagram.com
2. If you don't have a session logged in start one
3. Open development tools witch Ctrl + Shift + I
4. Get to the application section and then to Cookies and select on the right hand side sessionId
   • For chromium browsers: application
   • For firefox browsers: storage

Now you can use the library by instantiating an object and passing the sessionId as an argument

const { Instagrapi } = require('instagrapi')

const instagrapi = new Instagrapi({
  sessionId: process.env.SESSION_ID // Load sessionId from an environment variable
})

instagrapi.getProfile('USERNAME').then(profile => {
  console.log(profile.followers) // Numbers followers of instagram account
})

Using typescript and async/await.

import { Instagrapi, TPost, TComment } from 'instagrapi'

const instagrapi = new Instagrapi({
  sessionId: process.env.SESSION_ID
})

async function getComments(): Promise<string[] | undefined> {
  try {
    const post: TPost = await instagrapi.getPost('POST_URL')

    const comments: string[] = post.lastComments.map((comment: TComment) => comment.content)

    console.log(comments) // Last comments of the post

    return comments
  } catch (error) {
    console.error(error)
  }
}

getComments()

Methods

• getProfile(<USERNAME>)

Get all the profile information of an instagram account. Receives as argument: <USERNAME>, the username of the instagram account.

Type of output in typescript:

type TProfile = {
  username: string
  image: {
    standard: string
    hd: string
  }
  qtyPosts: number
  followers: number
  following: number
  name: string
  biography: string
  externalUrl: string
  isBusiness: boolean
  isVerified: boolean
  isPrivate: boolean
}

• getLastPosts(<USERNAME>)

Get the last 12 posts of an instagram account. Receives as argument: <USERNAME>, the username of the instagram account.

Type of output in typescript:

type TLastPosts = Array<{
  postUrl: string
  image: string
  video: null | {
    url: string
    views: number | null
  }
  content: string | null
  likes: number
  qtyComments: number
}>

• getPost(<POST_URL>):

Get all the details of a post of an instagram account. Receives as argument <POST_URL>, the url of the post on instagram.

Type of output in typescript:

type TPost = {
  postUrl: string
  image: {
    standard: string
    hd: string
  }
  video: TVideo | null
  content: string | null
  likes: number
  qtyComments: number
  media: Array<TMedia>
  author: {
    username: string
    image: string
    qtyPosts: number
    followers: number
    name: string
    isVerified: boolean
    isPrivate: boolean
  }
  lastComments: Array<TComment>
  location: null | {
    country: string | null
    region: string | null
    city: string | null
    street: string | null
    zipCode: string | null
  }
  date: string
}

License

MIT © Edixon Piña