Developer API Documentation
The Zip-Tax.com API is designed to allow programmers to submit a request to our servers from a website or application and retrieve response data from our databases. The format of the response can be returned as JSON or XML. Simply pass the desired format as part of the request.
API URL
The Zip-Tax.com URL consists of three parts which form the basic url for the api request.
http://api.zip-tax.com/request/v20
| Sub Domain: | api.zip-tax.com |
| Action: | /request |
| Version: | /v20 Optionally use v10 for a summary data set. |
Sample - full formatted URL
The Zip-Tax.com API URL consists of the following GET Request parameters which are used to generate the result.
http://api.zip-tax.com/request/v20?key=1234567890&postalcode=90265&state=CA&format=JSON
| key | required | Your account key |
| postalcode | required | The 5 digit postal code. NOTE: Include leading zeros |
| state | optional | The 2 letter state code. Example: CA for California |
| city | optional | The full city name |
| format | optional | The return format. Valid formats are JSON or XML. The default format is JSON |
Response
The Zip-Tax.com API will return the following response values
| version | The API version string [ v10 or v20 ] |
| rCode (JSON) or code (XML) | The request reponse code |
| message (XML only) | Special service messages [depricated] |
| results (JSON) or response (XML) | The API result array |
Response Codes - [ rCode (JSON) or code (XML) ]
This list represents the response codes returned by the API
| 100 | SUCCESS |
| 101 | INVALID_KEY |
| 102 | INVALID_STATE |
| 103 | INVALID_CITY |
| 104 | INVALID_POSTAL_CODE |
| 105 | INVALID_FORMAT |
Results - [ results (JSON) or response (XML) ]
This list represents the results array values returned by the API
| geoPostalCode | Requested postal code | all versions |
| geoCity | City | all versions |
| geoCounty | County | all versions |
| geoState | State | all versions |
| taxSales | Total sales tax | all versions |
| taxUse | Total use tax | all versions |
| txbService | Taxable service (values: null,Y,N,L) | all versions |
| txbFreight | Taxable freight (values: null,Y,N) | all versions |
| stateSalesTax | Portion of total sales tax from the state level | v20 only |
| stateUseTax | Portion of total use tax from the state level | v20 only |
| citySalesTax | Portion of total sales tax from the city level | v20 only |
| cityUseTax | Portion of total use tax from the city level | v20 only |
| cityTaxCode | Applicable city tax code | v20 only |
| countySalesTax | Portion of total sales tax from the county level | v20 only |
| countyUseTax | Portion of total use tax from the county level | v20 only |
| countyTaxCode | Applicable county tax code | v20 only |
| districtSalesTax | Portion of total sales tax from the district level | v20 only |
| districtUseTax | Portion of total use tax from the district level | v20 only |
Sample JSON Response
Sample XML Response
Our Partners
