Sign in
latestOpenAPI 3.1.02026-08-19127114508.9 KB

da40606c043a

Users

Look up multiple users by IDs in one call

Look up multiple users by IDs in one call.

get/api/v1/x/users/batch

Query parameters

idsstring required

Comma-separated numeric user IDs (1-100 values). Duplicate IDs are ignored while preserving first-seen order.

minFollowersinteger

Minimum follower count. Filtering happens before billing.

maxFollowersinteger

Maximum follower count. Missing counts pass this maximum.

minAccountAgeDaysinteger

Minimum account age in whole days.

verifiedOnlyboolean

Only return verified profiles.

Response

Matched users plus reconciliation metadata for unavailable IDs.

filtered_countinteger

Profiles rejected by the requested filters.

has_next_pagefalse required

Batch lookups never paginate.

next_cursorstring required

Empty because batch lookups never paginate.

requested_countinteger required

Number of unique IDs requested.

processed_countinteger required

Number of requested IDs included in the lookup.

returned_countinteger required

Number of user profiles returned and charged.

unavailable_idsstring[] required

Processed IDs with no returned profile, in first-seen request order.

unprocessed_idsstring[] required

Requested IDs skipped because available credits limited processing. Retry these IDs after adding credits.

Example response

{
  "users": [
    {
      "id": "9876543210",
      "username": "elonmusk",
      "name": "Elon Musk"
    }
  ],
  "requested_count": 2,
  "processed_count": 2,
  "returned_count": 1,
  "unavailable_ids": [
    "1234567890"
  ],
  "unprocessed_ids": []
}