Instagram API
Instagram stories
A public account's stories live right now: media URLs, posting and expiry times, mentions, hashtags, link and music stickers. Empty when nothing is live.
Endpoint
GET/v1/instagram/storieslive · proven5 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
handle | yes | Instagram username, with or without the leading @ | 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 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/instagram/stories?handle=nasa" \ -H "x-api-key: mn_your_key_here"
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/stories?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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/instagram/stories?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.
{
"success": true,
"platform": "instagram",
"endpoint": "/v1/instagram/stories",
"data": {
"_meta": {
"billing": {
"charged": 0,
"list_price": 0,
"reason": "example"
}
},
"count": 0,
"handle": "example",
"has_more": false,
"items": []
},
"credits_used": 5,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative 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.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
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 |
|---|---|---|
_meta | object | null | Optional meta supplied by this operation. Null means unknown. |
_meta.billing | object | null | Optional billing supplied by this operation. Null means unknown. |
_meta.billing.charged | number | null | Optional charged supplied by this operation. Null means unknown. |
_meta.billing.list_price | number | null | Optional list price supplied by this operation. Null means unknown. |
_meta.billing.reason | string | null | Optional reason supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
handle | string | null | Optional handle supplied by this operation. Null means unknown. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
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