Browse the docs

Answers and errors

The shape of every answer, what a notice means, and what an error carries.

An answer

Every answer
{
  "data": …,
  "asOf": "…",
  "notice": "…"
}
  • data is what you asked for; each endpoint’s page shows an abridged example.
  • asOf is the moment the answer was made, as an ISO timestamp.
  • notice appears when the answer quotes text written outside WiseView — headlines, filings, transcripts — so a script that hands it to an AI can say it is quoted material, not instructions.

An error

Every error
{
  "error": {
    "code": "…",
    "message": "…"
  }
}

The code is stable — branch on it. The message is a plain sentence you can show a person.

Every code the API answers with, generated from the API itself:

StatusCodeWhen
400invalid_paramsA parameter is unknown, missing, given twice or out of range. The message names it.
400key_in_addressA key was put in the address. Send it in the Authorization header instead.
401missing_keyNo key was sent. Send "Authorization: Bearer wv_live_…".
401invalid_keyThe key is not one of ours. Check it was copied whole.
401key_revokedThe key was revoked. Make a new one in your account, under API.
403switched_offThe API is switched off right now.
403blockedThe API is turned off for this account.
403account_closedThis account cannot be used right now.
403membership_requiredThe account has no active membership.
403not_on_planThe account's plan does not include the API. The free plan has no keys.
403endpoint_offThis endpoint, or the feature behind it (like the squawk), is switched off right now.
403members_onlyThe account's plan does not include this endpoint's data.
404not_foundThe lookup found nothing (an unknown report id, a name with no trades), or there is no endpoint at this address. Not counted.
405method_not_allowedAnything but GET. The API is read-only.
429rate_limitedToo many calls this minute. Wait a moment.
429allowance_used_upThis month's calls (or a trial's) are used up. Carries refillsAt and trialEndsAt.
500server_errorSomething went wrong on our side. Try again in a moment.
502lookup_failedThe lookup failed on our side. Not counted; try again shortly.

Only GET is answered: the API reads, and changes nothing in your account.

This page as Markdown · for AI apps, as is llms.txt