/twitter/user/highlights

POST /api/twitter/user/highlights

Price: 1 credit

Twitter Get User Highlights

How to use it

Get the highlighted posts of a Twitter user. Accepts username, URL, or numeric user ID. Resolves username to ID automatically.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — User ID, alias or URL (examples: "NASA")
• count integer required — Max result count (>: 0)

Response

• @type string (default: "TwitterPost")
• id string required
• created_at integer nullable
• url string required
• text string required
• user object nullable
  • @type string (default: "TwitterPostUser")
  • rest_id string required
  • name string required
  • alias string required
  • url string required
  • image string nullable
  • verified boolean (default: false)
  • verified_type string nullable
  • is_blue_verified boolean (default: false)
• retweet_count integer (default: 0)
• favorite_count integer (default: 0)
• reply_count integer (default: 0)
• quote_count integer (default: 0)
• view_count string nullable
• is_retweet boolean (default: false)
• retweeted object nullable (see schema TwitterPost)
• is_quote boolean (default: false)
• quoted object nullable (see schema TwitterPost)
• in_reply_to_status_id string nullable
• in_reply_to_user_id string nullable
• in_reply_to_screen_name string nullable
• lang string nullable
• source string nullable
• possibly_sensitive boolean (default: false)
• medias array (default: [])
  • @type string (default: "TwitterMedia")
  • media_id string required
  • media_url string nullable
  • type string nullable
  • width integer nullable
  • height integer nullable
  • alt_text string nullable
  • preview_image_url string nullable
  • duration_ms integer nullable
  • video_url string nullable
  • expanded_url string nullable
  • allow_download boolean (default: true)
  • source_user_id string nullable
  • source_status_id string nullable
• urls array (default: [])
  • @type string (default: "TwitterUrl")
  • display_url string required
  • expanded_url string required
  • url string required
  • indices array nullable
• hashtags array (default: [])
  • @type string (default: "TwitterHashtag")
  • text string required
  • indices array (default: [])
• user_mentions array (default: [])
  • @type string (default: "TwitterPostUserMention")
  • user_id string required
  • name string nullable
  • alias string required
  • url string required
  • indices array (default: [])
• card object nullable
  • @type string (default: "TwitterCardInfo")
  • description string nullable
  • domain string nullable
  • vanity_url string nullable
  • image_url string nullable
  • url string nullable
  • card_type string nullable
• poll object nullable
  • @type string (default: "TwitterPoll")
  • choices array (default: [])
    • @type string (default: "TwitterPollChoice")
    • label string required
    • count integer (default: 0)
    • percentage number (default: 0)
  • ended_at integer nullable
  • duration_minutes integer (default: 0)
  • is_final boolean (default: false)
  • last_updated_at integer 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 — User not found. Verify the username. 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.