Skip to main content

Qualified Name

Qualified Name

Eligibility gate for giveaways: checks whether an account's display name contains the required text. Match anywhere, on the left (starts with), or on the right (ends with). Case-insensitive.

GET/v2/users/:username/check-qualified-nameCheck if an account display name contains the required text.
ParameterTypeRequiredDefaultDescription
usernamestringrequired—Username, with or without @ (path parameter)
containsstringrequired—Text the display name must contain
positionstringoptional—Where to match: anywhere (default), left, right
BASH
curl "https://xcrop.io/api/v2/users/elonmusk/check-qualified-name?contains=Musk&position=right" \
  -H "Authorization: Bearer $XCROP_API_KEY"
ResponseJSON
{
  "data": {
    "username": "elonmusk",
    "qualified": true,
    "name": "Elon Musk",
    "contains": "Musk",
    "position": "right"
  },
  "meta": { "latency_ms": 198 }
}

More in Interaction Check

Full documentation with search: xcrop.io/docs