TaxJar-compatible rate lookup (address / decomposed / lat-lng / ZIP)

GET

/v1/portability/rates

• Production
• Local development

Drop-in replacement for TaxJar’s GET /v2/rates/{zip} with broader input flexibility. Accepts a freeform address= string, decomposed street=&city=&state=&zip=, lat-lng coordinates, or ZIP-only — the engine picks the most precise available path.

Returns the same shape as TaxJar’s rate response (state, county, city, combined rate) plus TaxQL’s expanded components and confidence envelopes for transparency.

Parameters

Query Parameters

address

Any of:

string

string

<= 200 characters

null

null

Freeform full address.

street

Any of:

string

string

<= 200 characters

null

null

Decomposed: street.

city

Any of:

string

string

<= 80 characters

null

null

Decomposed: city.

state

Any of:

string

string

<= 40 characters

null

null

State (2-letter or full name).

zip

Any of:

string

string

<= 10 characters

null

null

5- or 9-digit ZIP.

lat

Any of:

number

number

>= -90 <= 90

null

null

lng

Any of:

number

number

>= -180 <= 180

null

null

as_of

Any of:

string

string

/^\d{4}-\d{2}-\d{2}$/

null

null

format

Format

string

default: both /^(taxjar|native|both)$/

seller_state

Any of:

string

string

<= 40 characters

null

null

Seller’s state (2-letter or full name). With nexus_states, drives sourcing decision.

seller_zip

Any of:

string

string

<= 10 characters

null

null

Seller’s ZIP — used to resolve origin rate when sourcing selects origin.

seller_street

Any of:

string

string

<= 200 characters

null

null

Optional seller street for sharper origin resolution.

seller_city

Any of:

string

string

<= 80 characters

null

null

Optional seller city.

nexus_states

Any of:

string

string

null

null

CSV of state codes the seller has nexus in (e.g. ‘tx,ca,ny’). When provided, drives the has_nexus decision.

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Rate resolved. Returns combined rate + components + confidence.

Response Get Portability Rates V1 Portability Rates Get

object

key

additional properties

any

400

Invalid input — missing required parameter or malformed value.

401

Missing or invalid X-API-Key / Authorization header.

404

Address could not be resolved by any geocoder.

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

429

Monthly quota exceeded.

503

Upstream geocoder unavailable.