Skip to main content

Users Status: XCROP API Documentation

Users Status

Check whether accounts are active, suspended or not found, and read their verified badge, in one request for up to 1,000 usernames. Add the optional about and profile field groups for the account country, signup source, username changes, counts and bio

POST/v2/users/statusAccount state, verified badge and optional about/profile fields for up to 1,000 usernames
ParameterTypeRequiredDefaultDescription
usernamesstring[] | stringrequired—Usernames to check. An array, or one string split on commas, spaces or new lines. A leading @ is fine, duplicates are dropped, max 1,000 unique
fieldsstring[]optional—Optional field groups: about (country, signup source, username changes, affiliate) and profile (followers, following, tweets, media, likes, listed, bio, location, website, restricted, withheld_in, professional_type, can_dm). Empty or omitted returns the status fields only, at the one-group price

Every row carries username, status (active, suspended, unavailable or not_found), reason, id, name, protected, verified, badge (blue, gold, grey or null), verified_type, identity_verified, created_at and avatar. In the about group, location_accurate false means X says the account may use a proxy or VPN

BASH
curl -X POST https://xcrop.io/api/v2/users/status \
  -H "Authorization: Bearer $XCROP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"usernames":["elonmusk","Google","WhiteHouse"],"fields":["about"]}'
ResponseJSON
{
  "data": [
    {
      "username": "elonmusk",
      "status": "active",
      "reason": null,
      "id": "44196397",
      "name": "Elon Musk",
      "protected": false,
      "verified": true,
      "badge": "blue",
      "created_at": "2009-06-02T20:12:29.000Z",
      "about": {
        "country": "United States",
        "signup_source": "United States App Store",
        "username_changes": 0,
        "affiliate": "X"
      }
    },
    { "username": "Google", "status": "active", "badge": "gold" },
    { "username": "WhiteHouse", "status": "active", "badge": "grey" },
    {
      "username": "suspendedexample",
      "status": "suspended",
      "reason": "suspended",
      "id": null,
      "name": null,
      "protected": null,
      "verified": null,
      "badge": null,
      "created_at": null
    }
  ],
  "meta": {
    "requested": 4,
    "returned": 4,
    "active": 3,
    "suspended": 1,
    "not_found": 0,
    "unavailable": 0,
    "failed": [],
    "fields": ["about"],
    "reads": 4,
    "latency_ms": 1200,
    "credits": 72
  }
}

Price: 18 credits (the profile rate) per username per field group read, so 18 with one group or none and 36 with both. A suspended or not_found account is charged because it is an answer, but only one read since there is no second group to read. A username whose read failed is not charged and is listed in meta.failed. If every read fails the call returns 503 and nothing is charged

‹ User EndpointsCheck Relationship ›