Remaining Quotes

When using the Rates endpoints, the number of remaining quotes in the current billing period is returned in the X-Rate-Limit-Remaining header.

The Remaining Quotes endpoint can also be used to get the number of quotes remaining.

GET /v2/remaining_quotes.:output_format

output_format

The :output_format URL part determines how information is returned. It can be one of the following values:

  • json – Javascript Object Notation
    • All real numbers in JSON responses are returned as strings to prevent JSON parsers from damaging the precision of the quotes.
  • xml – Well-formed XML document
  • csv – Comma Separated Values
    • Can be imported into most spreadsheet and financial applications
    • Note that CSV format provides standard Unix-like line endings (Unix, Linux, *BSD, MacOS > 9 among others) via an LF character (hex: 0x0A; dec: 10)
    • Due to the limitations of this format, only quotes will be returned, and metadata will be excluded from the output

Responses

JSON

Request:

GET /v2/remaining_quotes.json

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: application/json
1
2
3
    {
       "remaining_quotes" : 10000
    }

XML

Request:

GET /v2/remaining_quotes.xml

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: application/xml
1
2
3
<response>
  <remaining_quotes>10000</remaining_quotes>
</response>

CSV

Request:

GET /v2/remaining_quotes.csv

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: text/plain
1
2
remaining_quotes
10000

Response Fields

remaining_quotes – The number of quotes remaining for the current billing period

  • If your plan is not quote limited, this endpoint returns the string ‘unlimited’