users

Profiles by handle, batch

Up to 100 profiles in one call. 1 credit per profile found; handles that do not exist are listed in errors and cost nothing. Duplicates are folded. Results in input order. Also GET /v1/users/batch?handles=a,b,c. When the balance covers only part of the list, the tail comes back as no_credits and is not fetched.

post/v1/users/batch

Request

  • Base URL: https://api.xdataapi.io
  • URL: https://api.xdataapi.io/v1/users/batch
  • Auth: one of:
    • API key in header x-api-key
    • OAuth 2 (authorization code, authorization URL https://xdataapi.io/oauth/authorize, token URL https://xdataapi.io/api/oauth/token, scopes: read)

Query parameters

freshboolean

Bypass the cache. Costs 2x credits.

Request body

handlesstring[] required

Example request

{
  "handles": [
    "x",
    "github",
    "vercel"
  ]
}

Response

OK

itemsinteger required

Objects returned.

credits_chargednumber required
balance_remainingnumber required
cache'miss' | 'hit' | 'mixed' | 'bypass' required
cache_hitsinteger required

Objects served from cache

request_idstring uuid required

Example response

{
  "data": [
    {
      "id": "783214",
      "handle": "X"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.