Instagram engagement API

Endpoint

GET/v1/instagram/engagementlive · proven10 credits

Parameters

Query parameters

Name	Required	Description	Example
`handle`	yes	Instagram username without @.	`nasa`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/instagram/engagement?handle=nasa" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/instagram/engagement?handle=nasa",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/instagram/engagement?handle=nasa",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "instagram",
  "endpoint": "/v1/instagram/engagement",
  "data": {
    "computed": {
      "followers": 1200,
      "posts_observed": 3,
      "posts_with_both_metrics": 2,
      "average_interactions": 24,
      "engagement_rate_percent": 2
    }
  },
  "credits_used": 10,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example uses fictional values and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`profile`	`object`	Nested response fields; optional unless explicitly documented.
`profile.id`	`string \| null`	Source identifier. Preserve its exact string value; do not convert large IDs to numbers.
`profile.handle`	`string \| null`	Public account username.
`profile.name`	`string \| null`	Display name.
`profile.url`	`string \| null`	Original source URL when supplied.
`profile.bio`	`string \| null`	Public biography.
`profile.bio_link`	`string \| null`	Original source URL when supplied.
`profile.avatar_url`	`string \| null`	Original source URL when supplied.
`profile.followers`	`number \| null`	Followers reported by the source; null or absent is unknown, not zero.
`profile.following`	`number \| null`	Following reported by the source; null or absent is unknown, not zero.
`profile.verified`	`boolean \| null`	Source verification flag; meaning depends on the platform.
`profile.posts_count`	`number \| null`	Posts reported by the source; null or absent is unknown, not zero.
`profile.business`	`boolean \| null`	Business-account flag.
`profile.private`	`boolean \| null`	Account privacy flag.
`items`	`array`	Nested response fields; optional unless explicitly documented.
`items[].id`	`string \| null`	Source identifier. Preserve its exact string value; do not convert large IDs to numbers.
`items[].url`	`string \| null`	Original source URL when supplied.
`items[].caption`	`string \| null`	Post caption.
`items[].created_at`	`string \| null`	Source publication time, normalized to an ISO date-time when available.
`items[].author`	`object`	Nested response fields; optional unless explicitly documented.
`items[].author.id`	`string \| null`	Source identifier. Preserve its exact string value; do not convert large IDs to numbers.
`items[].author.handle`	`string \| null`	Public account username.
`items[].author.name`	`string \| null`	Display name.
`items[].author.url`	`string \| null`	Original source URL when supplied.
`items[].stats`	`object`	Nested response fields; optional unless explicitly documented.
`items[].stats.likes`	`number \| null`	likes reported by the source; null or absent is unknown, not zero.
`items[].stats.comments`	`number \| null`	comments reported by the source; null or absent is unknown, not zero.
`items[].stats.plays`	`number \| null`	plays reported by the source; null or absent is unknown, not zero.
`items[].stats.shares`	`number \| null`	shares reported by the source; null or absent is unknown, not zero.
`items[].stats.saves`	`number \| null`	saves reported by the source; null or absent is unknown, not zero.
`computed`	`object`	Nested response fields; optional unless explicitly documented.
`computed.followers`	`number \| null`	Current followers reported by the source; null or absent is unknown, not zero.
`computed.posts_observed`	`number \| null`	Observed posts reported by the source; null or absent is unknown, not zero.
`computed.posts_with_both_metrics`	`number \| null`	Posts with both likes and comments reported by the source; null or absent is unknown, not zero.
`computed.average_interactions`	`number \| null`	Mean likes + comments over usable pairs.
`computed.engagement_rate_percent`	`number \| null`	100 × average_interactions / followers; null for missing or zero followers, or no usable pair.
`partial`	`boolean \| null`	Whether collection was partial.
`complete`	`boolean \| null`	Source completion flag; this operation is a bounded sample.
`_warnings`	`array`	Collection limitations or component warnings. Read before interpreting coverage.

One profile and one posts page, with no continuation. This is a followers-based percentage, not a views-based ratio.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Instagram sampled engagement

Query parameters

Make the request

Response fields and example

First call in under a minute

Instagram sampled engagement

Query parameters

Make the request

Response fields and example

More Instagram reference

First call in under a minute