# Quick start

Create an OSINTverse API key, pick a provider, and run your first OSINTOne API search in about five minutes.

URL: https://osintverse.com/docs/quick-start

Three steps from zero to a completed search. Prefer clicking to coding? [Run the same search in SearchIn](https://osintverse.com/docs/guides/searchin) instead.

## Get an API key

[Sign in](https://osintverse.com/login), choose the workspace that should pay (Personal or a team), and open [Dashboard → API keys](https://osintverse.com/dashboard/api). Create a key and copy the secret now. It is shown only once.

Keys start with `ov_` and are hashed at rest. Personal keys bill your wallet; team keys bill the team.

## Pick a provider and input type

Every search is a `provider` + `input_type` + `query`. Call `GET /v1/providers` (no auth) for live input types and prices, or check the [pricing matrix](https://osintverse.com/docs/pricing). Invalid pairs return HTTP **422** and cost nothing.

```bash title="List providers"
curl "https://apiv1.osintverse.com/v1/providers"
```

## Run the search

With the [Python SDK](https://osintverse.com/docs/python):

```bash
pip install osintverse
```

```python
from osintverse import OSINTverse

client = OSINTverse(api_key="ov_your_api_key")
search = client.search.create(
    provider="leakradar",
    input_type="email",
    query="user@example.com",
    wait=True,
)
print(search.status, search.result)
```

Or over HTTP with `x-api-key`:

```bash title="Create a search"
curl -X POST "https://apiv1.osintverse.com/v1/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ov_your_api_key" \
  -d '{"provider":"leakradar","input_type":"email","query":"user@example.com"}'
```

Most providers return `status: "completed"` with results in the create response. FaceCheck image searches and OSINT Industries lookups return `running`. [Poll until they finish](https://osintverse.com/docs/api/search), or pass `wait=True` in the SDK. OSINT Industries `result.matches` grows as modules finish.

> **Live API calls are charged.** `POST https://apiv1.osintverse.com/v1/search` with a real `ov_…` key debits your wallet when the search starts. A search with too little balance fails with status `failed` and is not charged. Add credits at [Billing](https://osintverse.com/dashboard/billing).

Want free fixtures first? [Open the API sandbox](https://osintverse.com/developers/sandbox). Its dummy routes use the same paths as the live API, the key `ov_sandbox`, and fixed sample results (including a preloaded OSINT Industries email). Nothing is billed.

## Next

* [Python SDK](https://osintverse.com/docs/python): bulk, unlock, premium modules, and exceptions.
* [Authentication](https://osintverse.com/docs/authentication): headers, rate limits, and key lifecycle.
* [Code examples](https://osintverse.com/docs/api/examples): cURL, Python, and JavaScript.
* [Providers](https://osintverse.com/docs/providers): what each source returns.

- [Get an API key](https://osintverse.com/dashboard/api)
- [OpenAPI spec](https://osintverse.com/openapi.json) and [Swagger UI](https://apiv1.osintverse.com/docs)
- [API sandbox (free, mock data)](https://osintverse.com/developers/sandbox)
- [Pricing](https://osintverse.com/pricing.json)