Endpoints
SearchIn REST endpoints on apiv1.osintverse.com.
All paths are relative to https://apiv1.osintverse.com.
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /health | No | Service health check. |
GET | /v1/providers | No | Provider catalog with supported input types and pricing. |
POST | /v1/search | Yes | Create and run an OSINT search. |
POST | /v1/search/bulk | Yes | Create many searches (queries[] × providers[]). |
GET | /v1/search/:id | Yes | Poll async search status and retrieve results. |
Interactive docs: Swagger · ReDoc · OpenAPI JSON
GET /v1/providers
Returns the live catalog. Use it to discover valid provider + input_type pairs and price_usd before you search. Caching this for a few minutes is fine; prices can change.
POST /v1/search
Creates a billed search. Charge is applied when the search is accepted. Upstream failures after billing set status refunded and restore the balance.
| Field | Type | Required | Description |
|---|---|---|---|
provider | string | Yes | Provider id from GET /v1/providers, for example leakradar-lite or securitytrails. |
input_type | string | Yes | One of email, username, phone, domain, name, image, or ip — must be valid for the provider. |
query | string | Yes | The identifier or URL to search. Image providers accept a public image URL. |
POST /v1/search/bulk
Creates up to 100 billed searches in one call: every queries[] × providers[] pair (max 50 queries). Partial success is expected — check searches[] and summary. Poll any running job with GET /v1/search/:id. Each job counts toward the daily key rate limit.
| Field | Type | Required | Description |
|---|---|---|---|
input_type | string | Yes | Shared input type for every query. |
queries | string[] | Yes | Identifiers or image URLs (deduped after validation). |
providers | string[] | Yes | Provider ids to run for each query. |
GET /v1/search/:id
Returns the same search object as create. FaceCheck may stay running for several seconds — poll about every 2 seconds. You can only read searches owned by the key's account (404 otherwise).