Guides
Migrating from v1
The request body and the profile format are unchanged. What changes is how the results reach you.
v1 · POST /api/search | v2 | |
|---|---|---|
| Calls | One | POST to start, GET to read |
| Results | All at once, at the end | Source by source, as they arrive |
| Request body | query, query_type, networks | Unchanged |
| Profile format | A list of profiles | Unchanged, in the data of each result |
| Rejected networks | Mixed into the results list | In networks_rejected of the POST response |
| A source that failed | Absent from the results | A source_error with its reason |
| Connection drop | The search and its results are lost | Reconnect with Last-Event-ID |
| Our server restarts | The request fails | failed, credit refunded |
| Same search sent twice | Two searches, two credits | One search, one credit |
| Searches at once | No limit | 3 per key |
Rebuilding v1's list
Concatenate the data of every result until done. v1 is unchanged and stays available.