Scrapes
Stop scrape
Stop a live scrape: keep what it delivered and refund the rest.
api.leadity.io/v1/scrapes/{id}/stopwriteMCP tool stop_scrapeStops a live scrape. It finishes the searches already in flight, keeps and charges only the leads it delivered, and refunds the rest of the hold when it settles. A stopped scrape cannot be resumed: to search further, place a new order, which skips the ground already swept. A scrape that is no longer live answers not_active. Needs a key with the write scope.
Headers
Bearer, a space, then an API key: Bearer lk_api_... An MCP key is refused here with wrong_key_kind.
Path parameters
The scrape's id, as create_scrape and list_scrapes answer it.
1 to 64 characters, matches ^[A-Za-z0-9]{1,64}$.
Response
Normally stopping. Watch it with get_scrape_status until complete is true.
One ofreservingqueuedrunningstoppingsettlingcompleted
Errors
Every refusal answers { error, message } with the status below. The full list is on the Errors page.
| Code | Status | Meaning | Extra fields |
|---|---|---|---|
| unauthorized | 401 | The API key is missing, malformed, revoked or expired. | - |
| wrong_key_kind | 401 | This key opens the other surface: an API key works on the HTTP API, an MCP key on the MCP server. | - |
| insufficient_scope | 403 | The key does not carry the scope this operation needs. | requiredScope: The scope the operation needs: read, write or spend. |
| account_suspended | 403 | The account is suspended. | - |
| email_not_verified | 403 | The account's email address is not verified yet. | - |
| invalid_body | 400 | The request does not match the operation's schema. | issues: The problems found, each with path (the field as a dotted path, led by the part of the request it travels in: path, query or body, such as body.items.1) and message (what is wrong there). |
| not_found | 404 | No such resource on this account. | id: On export_scrapes: the first id that is not one of the account's scrapes. |
| not_active | 409 | The scrape is no longer live, so there is nothing to stop. | - |
| rate_limited | 429 | Too many requests. Wait for the Retry-After seconds and try again. | retryAfterSeconds: The seconds to wait, the same number as the Retry-After header. |
| try_again | 503 | Leadity could not answer just now. Retry in a moment, with the same Idempotency-Key on a spending call. | retryAfterSeconds: When a request with this Idempotency-Key is still being processed: the seconds to wait before retrying with the same key, as the Retry-After header says. |
| internal_error | 500 | Something failed on our side. Nothing was charged twice. | body: On the MCP server, when Leadity answered in a shape the tool does not publish: that answer as it came. |