API reference
Instagram Highlight Items API
Every item inside one story highlight, as normalized media.
Endpoint
/v1/instagram/highlightlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Highlight id from instagram/highlights. | 18195781759377100 |
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 "https://www.monocrawl.com/v1/instagram/highlight?id=18195781759377100" \ -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/highlight?id=18195781759377100",
{ 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/highlight?id=18195781759377100",
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/highlight",
"data": {
"cover": "example",
"id": "example",
"items": [
{
"author": {
"avatar_url": "https://example.com/example",
"handle": "example",
"id": "example",
"name": "example",
"private": false,
"verified": false
},
"carousel": [],
"coauthors": [],
"code": "example",
"created_at": "2026-09-01T12:00:00Z",
"display_url": "https://example.com/example",
"duration_s": 0,
"has_audio": false,
"id": "example",
"is_paid_partnership": false,
"is_video": false,
"media_urls": [
"example"
],
"platform": "example",
"product_type": "example",
"stats": {},
"thumbnail_url": "https://example.com/example",
"url": "https://example.com/example",
"video_url": "https://example.com/example"
}
],
"media_count": 0,
"platform": "example",
"title": "example"
},
"credits_used": 1,
"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 |
|---|---|---|
cover | string | null | Optional cover supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].author | object | null | Public author information supplied with this record. |
items[].author.avatar_url | string | null | Optional avatar url supplied by this operation. Null means unknown. |
items[].author.handle | string | null | Optional handle supplied by this operation. Null means unknown. |
items[].author.id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].author.name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].author.private | boolean | null | Optional private supplied by this operation. Null means unknown. |
items[].author.verified | boolean | null | Optional verified supplied by this operation. Null means unknown. |
items[].carousel | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].coauthors | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].code | string | null | Optional code supplied by this operation. Null means unknown. |
items[].created_at | string | null | Source creation time, not the API retrieval time. |
items[].display_url | string | null | Optional display url supplied by this operation. Null means unknown. |
items[].duration_s | number | null | Optional duration s supplied by this operation. Null means unknown. |
items[].has_audio | boolean | null | Optional has audio supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].is_paid_partnership | boolean | null | Optional is paid partnership supplied by this operation. Null means unknown. |
items[].is_video | boolean | null | Optional is video supplied by this operation. Null means unknown. |
items[].media_urls | array | null | Optional media urls supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].product_type | string | null | Optional product type supplied by this operation. Null means unknown. |
items[].stats | object | null | Optional stats supplied by this operation. Null means unknown. |
items[].thumbnail_url | string | null | Optional thumbnail url supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
items[].video_url | string | null | Optional video url supplied by this operation. Null means unknown. |
media_count | number | null | Optional media count supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
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