# Find.ly API

> Search leak and OSINT data from your own code with the Find.ly API.

- [Introduction](https://docs.findly.icu/index.md): Run Find.ly searches from your own code: the same five modules, quota and limits as the dashboard.
- [Authentication](https://docs.findly.icu/authentication.md): Get your API key and send it in a header.
- [Quickstart](https://docs.findly.icu/quickstart.md): Check your key, run a search and download a raw file with curl.
- [Modules and inputs](https://docs.findly.icu/guides/modules.md): The five search modules, their request bodies and their responses.
- [Billing and quotas](https://docs.findly.icu/guides/billing-and-quotas.md): What uses a request, what is free, and how to read your quota from every response.
- [Rate limits](https://docs.findly.icu/guides/rate-limits.md): Per-address and per-account limits, size limits and how to retry.
- [Errors](https://docs.findly.icu/guides/errors.md): One error envelope, stable codes, and what to do for each.
- [Pagination](https://docs.findly.icu/guides/pagination.md): The whole list comes back in one response. Page through it on your side.
- [Raw files and text output](https://docs.findly.icu/guides/raw-files.md): Download the file behind a result, and get plain text with ?format=txt.
- [Get usage](https://docs.findly.icu/api-reference/account/get-usage.md): Returns the plan, today's quota and the modules open to the account that owns the key. Never billed and never runs a search: use it to check that a key works.
- [Intelligence Search](https://docs.findly.icu/api-reference/search/intelligence-search.md): Free-text search by email, username, domain or keyword, with optional result count, media type, sort order and date filters. Returns up to 5,000 records in one response.
- [Phonebook](https://docs.findly.icu/api-reference/search/phonebook.md): Lists every known selector for a domain: email addresses (`type: email`), subdomains (`type: domain`) or URLs (`type: url`). Up to 5,000 selectors per response, or a plain text list with `?format=txt`.
- [Identity Portal](https://docs.findly.icu/api-reference/search/identity-portal.md): Looks up an email address, domain or other selector and returns the matching records, in the same shape as Intelligence Search.
- [System ID (raw file)](https://docs.findly.icu/api-reference/search/system-id-raw-file.md): Downloads the raw file behind a result. Pass the `system_id` of a record from Intelligence Search or Identity Portal. The file text (first 8 MB) comes back in JSON, or as a `text/plain` attachment with `?format=txt`.
- [Storage ID (raw file)](https://docs.findly.icu/api-reference/search/storage-id-raw-file.md): Downloads a raw file by its storage ID and bucket. The file text (first 8 MB) comes back in JSON, or as a `text/plain` attachment with `?format=txt`.

## OpenAPI Specs

- [openapi](/openapi.json)