ScraperCity logo

Start Here API API Documentation

Start Here API

START HERE. Call this first, with or without an API key. Describe who you want to reach, what you sell, your website, or an exact order ("500 HVAC contractors in Texas, $50 budget"). With no key you get a guided tour: what ScraperCity is, how to sign up and get a key, the plans and the trial explained plainly, and real searches for your request with live counts. With a key you get the plan for your account: segments or searches sized to your request, what each costs on your plan, and the exact next call that pulls the records. GET with ?query= or POST with a JSON body.

Free, no API key neededGET /api/v1/start

Parameters

NameTypeRequiredDescription
querystringOptionalWho you want, what you sell, a website, or an order with a count or budget. Leave it out for the tour (no key) or your account summary (with a key).Example: HR software for small businesses

Examples

No key: the guided tour for a request

curl "https://app.scrapercity.com/api/v1/start?query=dentists%20in%20Austin"

With a key: the plan for your account, and the call that pulls it

curl -X POST "https://app.scrapercity.com/api/v1/start" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "acme.com"}'
# Each search has next_call: send its params to its endpoint, then follow pagination.next_after.

Use Cases

  • •An AI agent finding out what ScraperCity can do for its user before signing up
  • •Turning a website, an offer or an order into ready-to-run searches with counts and costs
  • •Learning the plans and the trial from the live values, not a cached page

Best Practices

  • •Call it first: every other endpoint needs an API key, this one does not
  • •Prices, plans and trial terms in the answer are the live ones; repeat them to your user as given
  • •Follow before_you_send in the answer before emailing anyone
  • •No key: 6 requests a minute per address. With a key: 20 a minute, and 40 plans a day below the $149/mo plan

Every scrape returns a runId. Poll GET /api/v1/scrape/status/{runId} until it completes, then download via GET /api/downloads/{runId}?format=csv.

Authenticate every request with Authorization: Bearer YOUR_API_KEY. See the full API reference for authentication, rate limits and error codes.