Docs
View as Markdown

instagram.post_oembed

stable Standard may need a pack

Instagram post oEmbed: caption, author, thumbnail (public posts).

GET /v1/instagram/post_oembed

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.

What it costs#

  • Standard · 1 credit 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 post shortcode, e.g. CUbHfhpswxtmax 20 chars; must match [A-Za-z0-9_\-]{5,20}; trimmed

Request#

curl "https://api.onekey.dev/v1/instagram/post_oembed?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": "2673763756536958061_1371046974",
      "text": "I love @spacecenterhou! Some of the best Spaceflight hardware on display, including a flown @spacex Falcon 9 booster!!!"
    },
    "author": {
      "username": "everydayastronaut",
      "id": 1371046974,
      "url": "https://www.instagram.com/everydayastronaut"
    },
    "media": {
      "thumbnailUrl": "https://instagram.fpnq7-10.fna.fbcdn.net/v/t51.82787-15/649141724_18099622430508895_8987271955314495552_n.jpg?stp=dst-jpg_e35_s640x640_sh2.08_tt6&_nc_ht=instagram.fpnq7-10.fna.fbcdn.net&_nc_cat=107&_nc_oc=Q6cZ2gFoRRY_Nr3o4DWYba6ZCpspRby1kKxkxlOs7R1ohYBdRoqDGwqVILyiG0ABqloXOsA&_nc_ohc=OdBHS6KBjoYQ7kNvwEiGmAz&_nc_gid=Vcv0ulPPdaMl9NjZVWCZ6A&edm=ALY_pVYBAAAA&ccb=7-5&oh=00_AQMfHzjs2NRUFuHqGeLxghXmioDURAv_l7d8reTANipbnA&oe=6AC080F9&_nc_sid=57e406"
    }
  },
  "metadata": {
    "platform": "instagram",
    "endpoint": "post_oembed",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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
media_idcontent.id-
titlecontent.text-
author_nameauthor.username-
author_idauthor.id-
author_urlauthor.urlsafeUrl
thumbnail_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: stable (verified against the live source).