Skip to navigation
API referenceQuotes

Read a quote request

View as Markdown

Authentication

AuthorizationBearer

Your Truvo API key, sent as a bearer token. The prefix selects sandbox (trv_sandbox_) or live (trv_live_).

Path parameters

idstringRequired

Headers

PreferstringOptional

wait=N holds the read open for up to N seconds, where N is a whole number from 0 to 20. The answer comes as soon as the status is final or the time runs out, and it carries Preference-Applied when the server held the read open. When the server can't hold the request, it answers at once without Preference-Applied and with Retry-After. Wait that long before you poll again.

Response headers

Request-Idstringformat: "^req_[0-9a-f]{16}$"

The ID of this answer. An error body repeats it as request_id.

RateLimit-LimitintegerOptional
The calls this window allows, for the limit you're closest to reaching. The window is one minute, or one UTC day for a daily sandbox limit. A fixed window allows a burst of up to twice the limit across a window edge.
RateLimit-RemainingintegerOptional
The calls left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window ends and the count resets.
Preference-AppliedstringOptionalformat: "^wait=[0-9]+$"

wait=N when the server held the read open for up to N seconds. Absent when the server answered without holding the read open.

Retry-AfterintegerOptional
Sent when the server can't hold the read open. Wait this many seconds before you poll again.

Response

Status, quote summaries, and next actions. Reading it doesn't start a new quote.
idstringformat: "^qreq_[a-z0-9]{8,64}$"
versioninteger<=9007199254740991
lineenum
Allowed values:
environmentenum
Allowed values:
application_idstringformat: "^app_[a-z0-9]{8,64}$"
application_versioninteger<=9007199254740991
statusenum
Allowed values:
completenessenum
Allowed values:
quoteslist of objects
market_outcomeslist of objects
requirementslist of objects
assumptionslist of objects
next_actionslist of objects
failureobject or null

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error