Capzy Data API. Choose your source.
Find a supported site's endpoint, send its parameters, and receive JSON. Explore the reference here, then run and inspect requests in your dashboard playground.
Amazon search, at a glance
GET /v1/amazon/searchIllustrative example
Find the source you need
Every source has its own endpoints, required inputs and response shape. Open its reference to check coverage before building an integration.
All sources (46)
Your first Data API request
This Amazon example uses a source-specific GET endpoint. HTTP 200 returns source data; HTTP 202 returns a pending status and jobId. Inspect pending jobs in the Data API dashboard Runs page before sending another request.
Create a Data API key
Open the Data API dashboard to copy your dedicated Data API key. Plan credits are used first; additional usage is charged to your shared Capzy account balance.
Open Data APIChoose the source and action
Use the site's reference to find the method, path and required parameters. The Amazon search example sends query and domain to /v1/amazon/search.
Read Amazon search parametersInspect the JSON in the playground
Open the matching source in your dashboard, select the action, fill its inputs and run a request. Check the current endpoint price before running.
Open Amazon search playground
# Install: pip install requests
import os
import requests
response = requests.get(
"https://api.capzy.ai/v1/amazon/search",
headers={"X-API-Key": os.environ["CAPZY_DATA_API_KEY"]},
params={"query": "wireless earbuds", "domain": "com"},
timeout=120,
)
response.raise_for_status()
data = response.json()
if response.status_code == 202:
print("Pending:", data.get("status"), "Job:", data.get("jobId"))
print("Inspect this job in https://capzy.ai/dashboard/data-api/runs")
else:
for item in data.get("organic_results", []):
print(item["title"], item.get("price"))
print("Credits used:", response.headers.get("X-Credits-Used"))Know the contract before you call it
Authentication is shared across Data API sources. Methods, parameters and returned fields belong to each endpoint.
X-API-KeyRequired · header- Send your dedicated Data API key in this header. Keep it on the server and read it from CAPZY_DATA_API_KEY in these examples.
/v1/{source}/{path}Endpoint-specific · path- Follow the method and path in the source reference. For example, GET /v1/amazon/search takes query and domain as query parameters.
freshnessOptional · auto, cached, fresh- Choose the endpoint's supported freshness behavior. The default is auto. Cached results can be older than a live fetch.
X-Credits-UsedResponse header- Inspect the charged credits for the request. Endpoint prices and plan discounts are shown in the dashboard and source reference.
X-Next-CursorResponse header · when present- Some endpoints return a cursor for the next page. Use each endpoint's pagination parameters; not every source uses the same pagination model.
Use the source's actual response fields
An HTTP 200 Amazon search response exposes organic_results at the top level. HTTP 202 instead returns a status envelope with jobId; inspect it in the dashboard Runs page. This shortened successful response uses illustrative product data.
{
"search_information": {
"query": "wireless earbuds"
},
"organic_results": [
{
"title": "Example wireless earbuds",
"price": "$27.99",
"extracted_price": 27.99,
"asin": "EXAMPLE001"
}
]
}Pricing
Data API plans include a monthly credit allowance. Extra usage is charged to your shared Capzy account balance. Check the source reference for the current endpoint credit price.
Loading current prices…
A few things to know
Where does the playground open?
In Dashboard → Data API → Scrapers. Source links open that source's builder. Endpoint links preselect the matching action, so you can inspect the required inputs before running.
Can I use my solver API key?
Use the dedicated Data API key shown in the Data API dashboard. Data API has its own plan controls and included credits, while extra usage is funded by your shared Capzy account balance.
Does every source return the same JSON?
No. Each endpoint has a source-specific response shape. Inspect its documented response and handle missing or optional fields in your application.
What if an endpoint is coming soon?
The dashboard marks endpoints that are not verified or available to run. Use the supported actions shown there; a reference entry alone does not promise that an endpoint is ready.
Find a source. Try a real request.
The dashboard playground brings the inputs, response and current pricing together.
