Overview
API reference
Every operation of the Leadity HTTP API, generated from the definitions the API itself runs.
Each page in this reference is generated from the same definition the API serves and the MCP server registers as a tool, so the parameters, the examples and the MCP tool name on a page are what the API accepts today.
Base URL
https://api.leadity.io/v1Authenticate every request with an API key: Authorization: Bearer lk_api_.... See Authentication.
Reading a reference page
- Scope is what the key needs:
read,writeorspend. See API keys and scopes. - Spends credits marks an operation that takes credits. It needs an
Idempotency-Keyheader and amaxCreditsceiling, and a free operation prices it first. See Spending credits safely. - MCP tool is the name the same operation has on the MCP server. HTTP only means the MCP server does not carry it.
- Errors lists the codes every call of the operation's kind can meet, with the extra fields each can carry. The codes an order or an upgrade adds of its own are on Errors, with the rest.
OpenAPI
https://api.leadity.io/v1/openapi.jsonThe OpenAPI 3.1 document is generated from the same definitions as these pages.
Every operation
Catalog
Account
Billing
Scrapes
- POST/v1/scrapes/estimateEstimate scrape
- POST/v1/scrapesCreate scrape
- GET/v1/scrapesList scrapes
- GET/v1/scrapes/{id}Get scrape
- GET/v1/scrapes/{id}/statusGet scrape status
- POST/v1/scrapes/{id}/renameRename scrape
- POST/v1/scrapes/{id}/stopStop scrape
- GET/v1/scrapes/{id}/leadsList leads
- GET/v1/scrapes/{id}/leads.csvDownload leads
- GET/v1/scrapes/{id}/reviews.csvDownload reviews
- POST/v1/scrapes/exportExport scrapes
- GET/v1/scrapes/{id}/offersList scrape offers
- POST/v1/scrapes/{id}/residualsPurchase residuals
- POST/v1/scrapes/{id}/reveal-phonesPurchase phone reveal
- POST/v1/scrapes/{id}/emails/findPurchase email find
- POST/v1/scrapes/{id}/emails/verifyPurchase email verify
- POST/v1/scrapes/{id}/owner-namesPurchase owner names
Validations