Developer documentation

One gateway.
Every CAVSN API.

Use one account and one API key across the catalog. Each API keeps its own plan, quota, endpoint reference, and usage meter.

Get an API key Browse API references

Request format

https://cavsndata.com
/gateway/{api-slug}/{endpoint-path}

Send your key with X-API-Key or a Bearer token.

Quickstart

Make your first request

A CAVSN request has three parts: an active plan for the API, an API key, and a path from that API's reference page.

Create an exportable key

Sign in, open API keys, and create a key for your environment. Copy it when shown; the full secret cannot be recovered later.

Choose an endpoint

Open the API catalog, select an API, then review its path, HTTP method, parameters, and OpenAPI file.

Send the request

Place the API slug and endpoint path after /gateway/, then authenticate with your key.

Browser testing is built in. When signed in, each API page uses your default key automatically in the interactive tester.

Authentication

Authenticate every request

CAVSN accepts either of these standard headers. X-API-Key is the clearest option for most integrations.

RecommendedX-API-Key

X-API-Key: cvsn_live_••••••••

AlternativeBearer token

Authorization: Bearer cvsn_live_••••••••

A key identifies the account, not a single API. The same active key works for every API plan on that account.

Making requests

Call the gateway directly

Requests follow the method, path, parameters, and body defined on the selected API page. Query strings and supported request bodies are forwarded to the upstream service.

curl --request GET \
  --url 'https://cavsndata.com/gateway/amazon-data/search?query=mechanical%20keyboard' \
  --header 'X-API-Key: $CAVSN_API_KEY'

Originhttps://cavsndata.com/Gatewaygateway/API slugamazon-data/Endpointsearch

Do not send customer API keys to an upstream hostname. Always call the CAVSN gateway URL shown above.

Responses

Use the upstream response and gateway headers

Successful response bodies and content types come from the selected API. CAVSN adds headers that make requests traceable and quotas observable.

X-CAVSN-Request-Id

A unique identifier for support, debugging, and the request log.

X-RateLimit-Limit

The monthly request allowance of the active plan for this API.

X-RateLimit-Remaining

The estimated requests remaining after the current call.

CAVSN error envelope

{
  "error": {
    "code": "quota_exceeded",
    "message": "Your monthly request quota has been reached.",
    "requestId": "…"
  }
}

Plans & quotas

Each API is billed independently

Separate usage meters

Using one API never consumes the monthly allowance of another API.

One active plan per API

Your dashboard shows the plan, billing period, usage, and remaining allowance for every API.

Private access

Invite-only APIs and custom plans appear only after the account has been granted access.

Authenticated calls count toward the selected API's monthly plan. Check the response headers or usage dashboard before retrying large workloads.

Errors

Handle failures by status and code

Use the HTTP status for broad control flow and the stable error code for application-specific handling.

StatusCodeMeaning

401missing_api_keyNo API key was sent.

401invalid_api_keyThe key is invalid or has been revoked.

403api_subscription_requiredThe account has no active plan for this API.

404api_not_foundThe API does not exist or is private for this account.

404endpoint_not_foundThe path or HTTP method is not in the API specification.

429quota_exceededThe API plan's monthly request allowance is exhausted.

502upstream_unavailableThe upstream API could not be reached.

503upstream_not_configuredThe API is listed but its upstream is not connected.

504upstream_timeoutThe upstream did not respond within 30 seconds.

Security & observability

Treat API keys like passwords

Keep keys on the server

Store keys in environment variables or a secrets manager. Never commit them, embed them in public browser code, or include them in support messages.

Create separate keys for development and production.
Revoke a non-default key immediately if it may be exposed.
Request and response payloads, origin IP, and country metadata are encrypted and retained for 30 days.
Use the request ID when matching an application failure to the dashboard request log.

API reference

Ready to choose an endpoint?

Every API page includes categorized endpoints, parameters, code samples, live testing, and a downloadable OpenAPI document.

Explore all APIs

One gateway.Every CAVSN API.