Get Tax Rates (v5.0)

Deprecated

Returns comprehensive tax rates with geocoding support, multi-district breakdown, and Tennessee Single Article Tax calculations. Supports both USA and Canada.

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

keystringOptional10-100 characters

API key that authenticates the request and resolves the account’s plan, entitlements, and rate limits. Supply it either as this query parameter or the X-API-KEY request header. A missing, malformed, or unknown key returns response code 101.

formatenumOptionalDefaults to json

Serialization format of the response body. ‘json’ (default) returns a JSON object; ‘xml’ returns the same data as an XML document.

Allowed values:
countryCodeenumOptionalDefaults to USA

Country of the lookup: ‘USA’ (default), ‘CAN’, or a US territory (ASM, GUM, MNP, PRI, VIR). ‘CAN’ requires the Canadian rates (rate_loc_can) entitlement; otherwise the request returns response code 112. US territories are looked up via the USA path and require no additional entitlement.

postalcodestringOptionalformat: "^[0-9]{5}$"=5 characters

5-digit US ZIP code to look up. When supplied on its own the response may contain multiple results, one per overlapping jurisdiction. An invalid format returns response code 104.

addressstringOptional<=100 characters

Street address to geocode to a single rooftop-level jurisdiction. Geocoding requires the geo_enabled entitlement; an incomplete or ungeocodable address returns response code 109.

statestringOptional<=50 characters

State name or two-letter abbreviation. Used with city or postal code to disambiguate the location. An invalid format returns response code 102.

stateCodestringOptionalformat: "^[A-Z]{2}$"=2 characters

Two-letter state code (e.g. CA). Alternative to ‘state’ for supplying the state as a code rather than a name.

citystringOptional<=50 characters
City name used together with state to narrow the lookup when no street address is supplied. An invalid format returns response code 103.
countystringOptional<=50 characters
County name used to refine the lookup when supplied without a street address.
latdoubleOptional-90-90

Latitude of a geographic point. When both lat and lng are supplied the API resolves the single jurisdiction containing that point (coordinate lookup).

lngdoubleOptional-180-180

Longitude of a geographic point. When both lat and lng are supplied the API resolves the single jurisdiction containing that point (coordinate lookup).

adjustmentstringOptional<=100 characters

Unincorporated-area handling. Only the value ‘auto’ has an effect: on geo (address) lookups in unincorporated areas it applies the appropriate sourcing adjustment. No default is applied when omitted, and no other value (including ‘origin’/‘destination’) changes the result.

sat_item_totaldoubleOptional>=0

Single-article item total in dollars used to compute Tennessee Single Article Tax (SAT). When greater than 0 and the location is in Tennessee, the response includes the satTaxDetail object describing the local tax limit and additional state tax on the single article.

historicalstringOptionalformat: "^[0-9]{6}$"

Historical period to price the lookup against, formatted YYYYMM (6 digits, e.g. 202401). Returns the rates that were in effect for that month. Requires historical data to be enabled; an invalid format returns response code 111.

Response

OK
addressDetailobject
Normalized and geocoded address details used for the lookup.
rCodelong

Numeric status of the request. 100 = success; 101 = invalid/unknown API key; 102 = invalid state; 103 = invalid city; 104 = invalid postal code; 105 = invalid query string; 106 = unknown API error; 107 = feature/version not enabled for the plan; 108 = request rate limit exceeded; 109 = missing/incomplete/invalid address; 110 = valid request but no result found; 111 = invalid historical parameter; 112 = Canadian (international) rates not enabled; 113 = product rate rules not enabled.

versionstring

Schema version of the response payload (e.g. ‘v50’).

resultslist of objects

Tax rate results for the request, each with a full state/county/city/district breakdown and sourcing model. Empty when no rate is found (response code 110).

satTaxDetailobject

Tennessee Single Article Tax breakdown. Present only when sat_item_total is supplied and the resolved location is in Tennessee.

Errors

422
Get Tax Rates V50request Unprocessable Entity Error
429
Get Tax Rates V50request Too Many Requests Error
500
Get Tax Rates V50request Internal Server Error