Our own visit statistics are always on. Google Analytics, which helps us understand how people use our public pages (not your signed-in workspace), is enabled only with your permission. See our Privacy policy.

POST

API health

24h health
Normal
24h average time
—
  • Healthy / normal
  • Available
  • Limited
  • Mostly down
Normal

List the story highlights on an Instagram profile. Each highlight has its ID, title, link, cover image, how many stories it holds, when it was created and last updated, and the account's ID and name. The stories inside a highlight are not returned, and media_count, created_at and updated_at are sometimes missing.

Price $1.6 per 1,000 requests ($0.001597 per call). Failed calls and empty results are not charged. Synchronous. For slow jobs add "mode": "async" to the body, take the job_id and poll.

AI prompt

Please help me write a data collection script with the EveryInfra Instagram Story highlights endpoint (instagram/highlights).

How the endpoint works:
- Request: POST https://api.everyinfra.com/api/v1/social with the header Authorization: Bearer <API key>. Read the key from the EVERYINFRA_API_KEY environment variable and never hard-code it.
- In the request body, set platform to instagram and action to highlights, and put the parameters inside params.
- Required parameters:
  - username: The account whose story highlights you want, such as nasa; a leading @ is removed and a profile link works too.
- Optional parameters:
  - limit: The most rows to return in this call, an integer from 1 to 100. The default applies when you leave it out, and a call can return fewer rows. Larger values are accepted and capped at the maximum. (default: 100)
- Returns a list of records. Main fields of each record: id, url, title, media_count, cover_url, created_at, updated_at, is_pinned, author_username, author_id, author_name.
- Example request body:
{
  "platform": "instagram",
  "action": "highlights",
  "params": {
    "username": "nasa"
  }
}
- Price: $1.6 per 1,000 requests; failed and empty results are not charged.
- For dozens or hundreds of targets, add "mode": "async" to the body: you get a job_id at once and poll GET https://api.everyinfra.com/api/v1/jobs/{job_id} for the result.
- On 422, fix the request using the suggested parameter names and allowed values in the error; on 429 or 503, wait for Retry-After and try again.

Before writing code, ask me which targets I need, how many, which fields, and what output format I want; then confirm the plan and the rough cost with me.

Request parameters

NameInTypeRequiredDefaultDescription
AuthorizationheaderstringYes-Bearer followed by your API key. Create it in the console; never put it in a URL or a code repository.
platformbodystringYesinstagramPlatform identifier, fixed value.
actionbodystringYeshighlightsCapability identifier, fixed value.
usernamebody.paramsstringYes-The account whose story highlights you want, such as nasa; a leading @ is removed and a profile link works too.
limitbody.paramsinteger (1–100)No100The most rows to return in this call, an integer from 1 to 100. The default applies when you leave it out, and a call can return fewer rows. Larger values are accepted and capped at the maximum.

Code samples

bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "platform": "instagram",
  "action": "highlights",
  "params": {
    "username": "nasa"
  }
}'

OpenAPI definition (JSON)Samples read the key from the EVERYINFRA_API_KEY environment variable; copied code never contains your key.

Response example

Field preview

No sample response is available for these parameters yet. This preview shows the response shape and fields from the API definition, with … as placeholders; it is not the result of a live call.

json
{
  "id": "req_…",
  "platform": "instagram",
  "action": "highlights",
  "results": [
    {
      "id": …,
      "url": …,
      "title": …,
      "media_count": …,
      "cover_url": …,
      "created_at": …,
      "updated_at": …,
      "is_pinned": …,
      "author_username": …,
      "author_id": …,
      "author_name": …,
      "platform": …
    }
  ],
  "count": …,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

Response fields

Business data is in results. The table lists the fields a record can contain; values the platform does not show are never made up.

FieldMeaning
idThe record's unique ID on the platform. Unique only within one platform; IDs can repeat across platforms.
urlLink to the record on the platform.
titleTitle. null when the platform has no titles (for example text-only posts).
media_countKeeps the platform's own meaning
cover_urlKeeps the platform's own meaning
created_atCreation time, same format as posted_at.
updated_atKeeps the platform's own meaning
is_pinnedKeeps the platform's own meaning
author_usernameAuthor's username (@handle), usually usable in URLs.
author_idAuthor's unique ID on the platform.
author_nameAuthor's display name.
platformSource platform identifier, the same as platform in the request (for example xiaohongshu, tiktok).

Errors and billing

401
Missing or invalid key.
402
Insufficient balance. Top up first.
422
Invalid parameter name or value. Fix it using the suggestions in the error. No charge.
429
Per-minute request limit reached. Wait for Retry-After, then try again.
503
Could not complete. The held charge is returned to your balance. If the outcome is unknown, verify it before you retry.
200 empty
No data. No charge.

Errors