Developer portal

API documentation

Everything on this page is generated from the live OpenAPI 3.1 document, so the examples always match the API.

Download openapi.json

Loading the API specification…

Authentication

Send your key in the Authorization header as a bearer token, or in an X-API-Key header. Both work on every endpoint.

HTTP
Authorization: Bearer wx_live_…
# or
X-API-Key: wx_live_…

Keys in the URL (?api_key=) are rejected, because URLs end up in browser history and server logs.

Base URL: https://search.api.woxa.com

Rate limits and quotas

Each key has a per-second limit and a monthly search quota set by its plan. Searches count against the quota; suggestions and usage checks do not. Quotas reset at the start of each calendar month (UTC). Failed calls caused by our servers are not counted.

Errors

Errors always return JSON in the same shape, with a stable machine-readable code:

JSON
{
  "error": {
    "code": "quota_exceeded",
    "message": "monthly query quota for this plan is used up; …"
  }
}
StatusCodeMeaning
400invalid_requestA parameter or body field is missing or invalid.
401unauthorizedNo key was sent, or the key is not valid.
403key_revokedThe key was rotated or revoked.
429rate_limitedToo many requests per second. Wait for Retry-After seconds.
429quota_exceededThe monthly quota is used up. It resets next month, or you can upgrade.
500internal_errorSomething failed on our side. The call was not counted.

Search operators

Operators go inside q, just like on woxa.com: site:, -site:, "exact phrase", -word, intitle:, inurl:, filetype:, after:YYYY-MM-DD and before:YYYY-MM-DD.

What we record

For each key we count requests and errors per day and per month, and note when the key was last used (to the minute). We do not record query text, result URLs or the addresses of your users.