Livescraper
Sign inGet Started
Home  ·  Developers  ·  OpenAPI Specification
OpenAPI Specification

Spec-driven
by default.

OpenAPI 3.1 spec for every Livescraper endpoint. YAML, JSON, Postman collection, codegen-ready. Stable v1 contract — never broken.

OpenAPI 3.1 specification

Machine-readable description of every endpoint, every parameter, every response schema. Drop it into Postman, Insomnia, your codegen, or any OpenAPI-compatible tool.

Download YAML Download JSON View Postman collection

One-click imports

PostmanRun in Postman InsomniaOpen in Insomnia BrunoAdd to Bruno HoppscotchSend to Hoppscotch

Codegen

Generate idiomatic clients for any language with openapi-generator:

openapi-generator-cli generate \
  -i https://api.livescraper.com/openapi.yaml \
  -g typescript-fetch \
  -o ./livescraper-client

Endpoints in this spec

  • POST/v1/maps/runRun Maps Scraper
  • POST/v1/reviews/runRun Reviews Scraper
  • POST/v1/serp/runRun SERP Scraper
  • POST/v1/email/runRun Email Scraper
  • POST/v1/b2b/searchSearch B2B Database
  • POST/v1/email/validateValidate Email
  • GET/v1/tasks/{id}Get task status
  • GET/v1/tasks/{id}/resultsStream task results
  • POST/v1/schedulesCreate schedule
  • DELETE/v1/schedules/{id}Cancel schedule
  • GET/v1/accountAccount + credits
  • POST/v1/webhooksRegister webhook