For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportLog InSign Up
GuidesAPI Reference
GuidesAPI Reference
  • Tax Rates
    • GETGet Tax Rates (v6.0)
  • Account
    • GETGet Account Metrics (v6.0)
  • Data
    • GETGet TIC Codes
    • POSTSearch TIC Codes
    • POSTRecommend TIC Codes
    • GETGet TIC Search JSON Schema
  • System
    • GETHealth Check
    • GETGet System Metadata
Logo
SupportLog InSign Up
Data

Get TIC Search JSON Schema

GET
/schemas/ticsearch
GET
/schemas/ticsearch
$curl https://api.ziptax.com/schemas/ticsearch \
> -H "Content-Type: application/json"
200Retrieved
1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "TIC Search Response",
4 "type": "object",
5 "properties": {
6 "results": {
7 "type": "array",
8 "items": {
9 "type": "object",
10 "properties": {
11 "taxJurisdictionCode": {
12 "type": "string",
13 "description": "The tax jurisdiction code",
14 "example": "CA-ON"
15 },
16 "taxRate": {
17 "type": "number",
18 "description": "Applicable tax rate as a decimal",
19 "example": 0.13
20 },
21 "taxType": {
22 "type": "string",
23 "description": "Type of tax",
24 "example": "Sales Tax"
25 },
26 "effectiveDate": {
27 "type": "string",
28 "format": "date",
29 "description": "Date when the tax rate became effective",
30 "example": "2023-01-01"
31 }
32 },
33 "required": [
34 "taxJurisdictionCode",
35 "taxRate",
36 "taxType",
37 "effectiveDate"
38 ]
39 }
40 },
41 "query": {
42 "type": "string",
43 "description": "The original search query",
44 "example": "Toronto"
45 },
46 "totalResults": {
47 "type": "integer",
48 "description": "Total number of results found",
49 "example": 25
50 }
51 },
52 "required": [
53 "results",
54 "query",
55 "totalResults"
56 ],
57 "additionalProperties": true
58}

Returns the JSON Schema describing the structure of /search/tic responses. Publicly accessible; no authentication required.

Response

OK
Was this page helpful?
Previous

Health Check

Next
Built with