Skip to main content

Classic Search (Deprecated)

Deprecated

The classic report-creation flow described on this page is deprecated and unavailable on production. Every classic call answers 403 with {"code": 403, "message": "classic search is not available"}. Use People search to create reports. This page is kept for integrations written against the classic flow.

The classic flow creates a report from one network and one username, then walks through each network's candidates one at a time:

1. Authenticate     POST /auth/signin
2. Create Report POST /create {"source": "ig", "username": "..."}
3. Get Profiles GET /create/{reportId}
4. Search / Page POST /create/{reportId}/{source}/search, GET /create/{reportId}/{source}
5. Add Profiles POST /create/{reportId}/{source}/add (one request per account)
6. Confirm POST /create/{reportId}/confirm
7. Monitor GET /sse/{reportId} or GET /check/{reportId}
8. Get Report GET /report/{reportId}

Steps 1, 7 and 8 are the same in People search; see Authentication, Report Pipeline and Real-time Updates. Classic calls that fail with the 403 above: GET /create/{reportId}, GET /create/{reportId}/{source}, POST /create/{reportId}/{source}/search, POST /create/{reportId}/{source}/add, and POST /create without fields.

Step 2: Create a report​

By username​

POST /create
{
"source": "ig",
"username": "username_to_search"
}
SourcePlatform
igInstagram
twTwitter
fbFacebook
ttTikTok
liLinkedIn

li may be refused (403 source cannot be searched) on deployments where LinkedIn search is turned off.

By name​

POST /create
{
"name": "John Smith",
"state": "CA"
}

Searches across the networks for matching profiles (US only).

The response is {"id": "<reportId>"}. Errors: 400 when neither a source with a username nor a name is given, 402 when the account has no report credits (to continue please upgrade your subscription, or You have reached search limit. Please Sign up to continue. for a guest).

Steps 3 and 4: Get the candidates​

All networks​

GET /create/{reportId}?limit=24

Returns the profiles of all networks at once.

One network​

GET /create/{reportId}/{source}?limit=16&offset=0

Page size​

limit accepts 8, 16, 24 or 32. Any other value is silently replaced by the default: 24 on GET /create/{reportId} and 16 on GET /create/{reportId}/{source}.

Search within a network​

If the account was not found, search directly:

POST /create/{reportId}/{source}/search
{
"username": "exact_username"
}

Profile status (badReason)​

A profile may carry a badReason saying why it cannot be analyzed:

ReasonDescription
privateProfile is private
notFoundProfile doesn't exist
zeroFollowsProfile follows no one
followsPrivateTikTok hid the following list; the account itself is not private
optOutUser requested data removal
unloadedData not yet loaded
unmappedProfile could not be mapped
unexpectedUnexpected failure

Use only profiles without a blocking badReason.

Step 5: Add profiles​

Add profiles one request per account; there is no bulk add:

POST /create/{reportId}/{source}/add
{
"id": "profile_id"
}
{
"added": true,
"unloaded": false,
"status": {
"type": "follows",
"status": "inited",
"id": "profile_id",
"source": "ig"
}
}

status.status is inited, inprogress, done or error. To include accounts of several networks, call add once per network. A 404 answers {"code": 404, "message": "profile not found"} when the profile id is not among the results. Once the report is already generated, add and search answer 403 report was already generated.

Step 6: Confirm​

POST /create/{reportId}/confirm
[
{"source": "ig", "id": "ig_profile_id"},
{"source": "tw", "id": "tw_profile_id"}
]
  • A signed-in account is required. A guest session gets 401.
  • If a network's slot was already filled by an earlier add call, confirm may list only that same account for the network; a different single id is refused. For a network that was never added, several accounts may be confirmed: the report is built from one, and the others are kept as the report's selected profiles.
  • Accounts that differ from those added earlier for a network are 400 profiles do not match those added earlier.
  • A repeat confirm is 409 report profiles were already confirmed.
  • Confirm does not spend a report credit; the credit check happened at POST /create, and the credit is spent the first time the owner reads the finished report.
{
"estimatedTime": 240,
"loadTimeout": 150
}

estimatedTime and loadTimeout are in seconds. estimatedTime: 0 means the data is already loaded.

ClassicPeople search
POST /create with source and username, or name and statePOST /create with fields
GET /create/{reportId}, GET /create/{reportId}/{source}, POST /create/{reportId}/{source}/searchPOST /people-search/run/{reportId}
POST /create/{reportId}/{source}/addpicked in a round (optional)
POST /create/{reportId}/confirmThe same call, with its People-search response fields

Everything after confirm (progress, GET /check/{reportId}, SSE, the report endpoints) is unchanged. See the People search guide.