Usernames

Search a username across the web

Sweep the site database for one handle and report every site's answer: found, notFound, or undecided when the site could not be read. Answers 202 with a job. Stream it or poll get_job. An identical search already running returns that same job and costs nothing.

post/usernames/search

Request

  • Base URL: https://api.socially.run/v1
  • URL: https://api.socially.run/v1/usernames/search
  • Auth: HTTP bearer

Request body

usernamestring required

The handle to look for. Letters, digits, dot, dash and underscore.

tier'fast' | 'full'

fast sweeps the top-ranked sites inside a minute (5 credits); full sweeps the whole database (20 credits).

categoriesstring[]

Only sweep sites in these categories.

sitesstring[]

Only sweep these site ids (from list_username_sites).

countriesstring[]

Only sweep sites that serve these countries (ISO 3166-1 alpha-2). A site is kept when it serves any of them.

includeNsfwboolean

Include sites marked as adult. Requires a plan that allows them.

includeUnreliableboolean

Also sweep sites the nightly check distrusts. They answer, but never above low confidence.

Response

Search a username across the web

dataunknown required

Changes

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