Authentication
Use the rewalto-core Clerk JWT template with audience rewalto-core-api, or an authorised rwk_ API key. Keep secrets on the server.
DEVELOPER GUIDE / CORE API
A clear contract.
A useful result.
Authenticate once, discover the available data, review the cost, and retain the source context with the result.
Get started with your AI agent.
Search all ten API documentation guides
EXPLORE THE DOCS
From first call to delivery.
Read the guides by task, inspect operation parameters and errors, or download the OpenAPI schema (version 0.101.0). GET /v1/version names the release answering today.
Make your first request
Configure an environment, authenticate, and check your identity before requesting data.
Read guideAuthentication and organisations
Session tokens and scoped API keys identify the caller and their organisation.
Read guideCreate and manage API keys
Manage organisation keys, their scopes and revocation.
Read guideRead commerce data
Retailers, brand profiles, listings and dated observations from the current core contract.
Read guideBalances, usage and receipts
Read credit balances, expiry, usage history and delivery receipts.
Read guideReview and approve a quote
Make the scope and cost visible before a run is authorised.
Read guideRefunds by receipt
Understand receipt eligibility and the refund request contract.
Read guideErrors and safe retries
Use the error envelope and request ID to decide what happens next.
Read guideUse the TypeScript client
Pin the client and contract together and keep authenticated requests on the server.
Read guideAPI, CLI and MCP (preview)
One data contract across applications, terminals and AI agents. The MCP server is in preview.
Read guideDiscover the data catalogue
Public catalogue search, status, fields, coverage and freshness.
Read guideCheck held data and request a missing type
Check product links and record demand without starting paid research.
Read guideDataset snapshots and exports
Review a whole-dataset snapshot, its licence and live credit quote.
Read guideCONNECT
Start with identity.
Send a bearer credential: a Clerk session token or an organisation API key. The API resolves the organisation from that credential.
Back to API overviewEnvironment
Configure REWALTO_CORE_API_URL for the environment you are connecting to. Pin the published @rewalto/client version supplied with that environment’s integration note.
Errors
Retain x-request-id when reporting a problem. Refresh an expired session before retrying. Never automatically repeat a timed-out write.
CONTRACT AT A GLANCE
The account and credit boundaries.
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/whoami | Signed-in identity and organisation |
| GET | /v1/credits/balance | Current credit balances and expiry |
| GET | /v1/credits/usage | Credit ledger and delivery receipts |
| POST | /v1/quotes | Review the cost of a request |
| GET | /v1/quotes/{id} | Read an organisation’s quote |
| POST | /v1/quotes/{id}/approve | Approve a quote before a run |
Endpoint availability follows the versioned contract for your connected environment. Quote approval reserves a ceiling; it is not itself proof that data was delivered.
Costs are explicit.
Context stays attached.
Before a run
Show a published rate or an approved quote. For recurring delivery, show both per-delivery and monthly costs.
After a result
Keep source and collection-date fields. Treat a missing field as unknown, and distinguish a collection timestamp from the publication date of a source.
Read llms.txt Guide: an API for India’s quick-commerce appsFROM QUESTION TO WORKFLOW
Make each result useful beyond the page.
Build a research assistant
Give your agent named fields with source URLs so it can explain where an answer came from.
Connect an internal workflow
Use structured records in analysis or an application. Preserve units, dates and unknown values through the integration.
Keep human approval explicit
Show the quote before execution. Handle an uncertain write outcome without silently starting the same job twice.
BEFORE YOU BEGIN
A little more context.
Make scope, evidence and cost part of the same decision.
How do I authenticate?
Send a bearer credential in the Authorization header: a Clerk session token or an organisation API key beginning rwk_. The authentication guide covers sessions, keys and keeping secrets on the server.
How are reads priced?
In credits. A read with a published rate shows the rate first; a read with no rate shows a quote, and it runs only after you approve it. The credits and quotes guides explain both.
Where is the first call example?
In the guide to making your first request: configure the environment, then call GET /v1/whoami with your bearer token. It reads your identity and does not start a data run.
ONE DATA LAYER / MANY POSSIBILITIES