Docs
View as Markdown

instagram.post

beta 2 credits needs a pack

A single Instagram post/reel by shortcode (graphql doc_id drifts, override via param).

GET /v1/instagram/post

What you get#

One Instagram record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also works with: URL lookup (instagram.com/p/{shortcode}, instagram.com/reel/{shortcode}) · Computed block (engagement_rate, estimated_reach, language). Any batch can include it.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
shortcodestringyes(required)Instagram shortcodemax 20 chars; must match [A-Za-z0-9_\-]{5,20}; trimmed
doc_idstringno8845758582119845GraphQL doc_idmax 20 chars; must match [0-9]{8,20}; trimmed

Request#

curl "https://api.onekey.dev/v1/instagram/post?shortcode=CUbHfhpswxt" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Instagram response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "content": {
      "id": "id0290",
      "text": "example content.text 0",
      "createdAt": "2023-11-14T22:13:20Z"
    },
    "ext": {
      "shortcode": "example content.shortcode 0"
    },
    "author": {
      "id": "id0548",
      "username": "example author.username 0"
    },
    "engagement": {
      "likes": 100,
      "comments": 100,
      "views": 100
    },
    "media": {
      "thumbnailUrl": "https://example.com/media/thumbnailurl/0"
    }
  },
  "metadata": {
    "platform": "instagram",
    "endpoint": "post",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
data.xdt_shortcode_media.idcontent.id-
data.xdt_shortcode_media.shortcodeext.shortcode-
data.xdt_shortcode_media.edge_media_to_caption.edges.0.node.textcontent.text-
data.xdt_shortcode_media.taken_at_timestampcontent.createdAttoIsoDate
data.xdt_shortcode_media.owner.idauthor.id-
data.xdt_shortcode_media.owner.usernameauthor.username-
data.xdt_shortcode_media.edge_media_preview_like.countengagement.likestoNumber
data.xdt_shortcode_media.edge_media_to_parent_comment.countengagement.commentstoNumber
data.xdt_shortcode_media.video_view_countengagement.viewstoNumber
data.xdt_shortcode_media.display_urlmedia.thumbnailUrlsafeUrl

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).