/telegram/posts

POST /api/telegram/posts

Price: 1 credit

Get Telegram Post

How to use it

Get a single public Telegram post by URL or {channel}/{id}. Returns text, media (photos, videos, documents), reactions, view count, forwarded source, reply, poll, and link preview.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• post string required — Post URL or {channel}/{id} (examples: "https://t.me/durov/300", "durov/300"; minLength: 1)

Response

• @type string (default: "TelegramPost")
• id string required
• url string nullable
• channel string nullable
• created_at string nullable
• text string nullable
• view_count integer nullable
• author string nullable
• is_edited boolean (default: false)
• is_album boolean (default: false)
• images array (default: [])
• videos array (default: [])
  • @type string (default: "TelegramVideo")
  • url string nullable
  • thumbnail string nullable
  • duration string nullable
  • duration_seconds integer nullable
• stickers array (default: [])
  • @type string (default: "TelegramSticker")
  • url string nullable
  • thumbnail string nullable
  • sticker_type string nullable
• documents array (default: [])
  • @type string (default: "TelegramDocument")
  • size string nullable
• voice_duration string nullable
• voice_duration_seconds integer nullable
• reactions array (default: [])
  • @type string (default: "TelegramReaction")
  • emoji string nullable
  • emoji_id string nullable
  • count integer nullable
  • is_paid boolean (default: false)
• forwarded_from object nullable
  • @type string (default: "TelegramForwardedFrom")
  • name string nullable
  • channel_alias string nullable
  • url string nullable
  • post_id string nullable
• reply_to object nullable
  • @type string (default: "TelegramReplyTo")
  • post_id string nullable
  • author string nullable
  • text string nullable
  • url string nullable
• poll object nullable
  • @type string (default: "TelegramPoll")
  • question string nullable
  • poll_type string nullable
  • voter_count integer nullable
  • options array (default: [])
    • @type string (default: "TelegramPollOption")
    • text string nullable
    • percent integer nullable
• link_preview object nullable
  • @type string (default: "TelegramLinkPreview")
  • url string nullable
  • site_name string nullable
  • description string nullable
  • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Post not found. Verify the URL or channel/id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.