API reference
Errors
Errors are JSON,
{"detail": "<message>"}. A request answered with an error never uses a credit.Start a search
| Status | detail | What to do |
|---|---|---|
| 401 | Invalid or missing API Key | Check the x-api-key header |
| 402 | No enough API quota. Please buy API credits at https://predictasearch.com/api | Buy credits |
| 403 | This search is not allowed | The person searched objected to the processing of their data. Do not retry |
| 403 | Your account is locked. Please contact an administrator | Contact support |
| 422 | Incorrect query format | Check the query against its query format |
| 422 | No network to search for this query type. Please check the available networks at /api/networks. | None of the networks named can be queried with this query_type. Check GET /api/networks |
| 422 | Validation details | The body is not valid JSON, or a field is missing or unknown |
| 429 | Too many searches in progress. Please wait for one to finish. | Wait Retry-After seconds, or for one of your searches to end |
| 503 | Maintenance in progress. Please try again later | Try again later |
| 503 | Search is temporarily unavailable | Try again later |
Stream the results
| Status | detail | What to do |
|---|---|---|
| 401 | Invalid or missing API Key | Check the x-api-key header |
| 403 | This search is not allowed | The person searched has objected since the search started, and its results are deleted. Do not retry |
| 403 | Your account is locked. Please contact an administrator | Contact support |
| 404 | The requested resource is not found | Unknown search_id, started by another key, or ended more than 1 hour ago |
| 422 | Invalid Last-Event-ID header | Send the id of an event you received, a whole number |
| 429 | Too many stream openings. Please wait before reconnecting. | Wait Retry-After seconds before reconnecting |
| 503 | Search is temporarily unavailable | Try again later |