{"openapi":"3.1.0","info":{"title":"Ziptax (BYOK) API","version":"0.1.0","description":"Ziptax (BYOK) lets an AI assistant read your own Ziptax data through the Ziptax API with a key you supply (Ziptax API key). Read-only: 6 tools (get_sales_tax_by_address, get_sales_tax_by_coordinates, get_sales_tax_by_postal_code, get_account_usage, search_tic_codes, list_economic_nexus_thresholds). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-ziptax.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-ziptax/docs"},"termsOfService":"https://connectorbay.com/byok-ziptax/terms"},"servers":[{"url":"https://byok-ziptax.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-ziptax/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_sales_tax_by_address":{"post":{"operationId":"get_sales_tax_by_address","summary":"Get the door-level sales tax rate for a street address: base rates by jurisdiction, total rate summaries, sourcing rule ","description":"Get the door-level sales tax rate for a street address: base rates by jurisdiction, total rate summaries, sourcing rule and whether services and shipping are taxable. Needs a key with geocoding enabled. Use for \"What is the sales tax rate at 200 Spectrum Center Dr, Irvine CA\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"address":{"description":"Street address with city and state, for example '200 Spectrum Center Dr Irvine CA 92618'.","maxLength":200,"title":"Address","type":"string"},"country_code":{"anyOf":[{"enum":["USA","CAN","PRI","ASM","GUM","MNP","VIR"],"type":"string"},{"type":"null"}],"default":"USA","description":"Country: USA (default), CAN (needs the Canadian rates entitlement) or a US territory (PRI, GUM, VIR, ASM, MNP).","title":"Country Code"},"taxability_code":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Optional Taxability Information Code of a product category; adds the product-specific rate rules for the location.","title":"Taxability Code"},"historical":{"anyOf":[{"maxLength":6,"type":"string"},{"type":"null"}],"default":null,"description":"Optional month YYYYMM (for example 202401) to return the rates in effect then; needs historical data enabled on the key.","title":"Historical"}},"required":["address"],"title":"get_sales_tax_by_addressArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sales_tax_by_coordinates":{"post":{"operationId":"get_sales_tax_by_coordinates","summary":"Get the sales tax rate for a latitude and longitude: base rates, total summaries, sourcing rule and service and shipping","description":"Get the sales tax rate for a latitude and longitude: base rates, total summaries, sourcing rule and service and shipping taxability. Needs a key with geocoding enabled. Use for \"What sales tax applies at latitude 33.6521, longitude -117.7449\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"lat":{"description":"Latitude from -90 to 90.","maximum":90,"minimum":-90,"title":"Lat","type":"number"},"lng":{"description":"Longitude from -180 to 180.","maximum":180,"minimum":-180,"title":"Lng","type":"number"},"country_code":{"anyOf":[{"enum":["USA","CAN","PRI","ASM","GUM","MNP","VIR"],"type":"string"},{"type":"null"}],"default":"USA","description":"Country: USA (default), CAN (needs the Canadian rates entitlement) or a US territory (PRI, GUM, VIR, ASM, MNP).","title":"Country Code"},"taxability_code":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Optional Taxability Information Code of a product category; adds the product-specific rate rules for the location.","title":"Taxability Code"},"historical":{"anyOf":[{"maxLength":6,"type":"string"},{"type":"null"}],"default":null,"description":"Optional month YYYYMM (for example 202401) to return the rates in effect then; needs historical data enabled on the key.","title":"Historical"}},"required":["lat","lng"],"title":"get_sales_tax_by_coordinatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sales_tax_by_postal_code":{"post":{"operationId":"get_sales_tax_by_postal_code","summary":"Get every sales tax rate overlapping a 5-digit US ZIP code (state, county, city and district parts, combined sales and u","description":"Get every sales tax rate overlapping a 5-digit US ZIP code (state, county, city and district parts, combined sales and use rates). One ZIP can have several results. Use for \"What sales tax rates apply in ZIP 92618\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"postalcode":{"description":"5-digit US ZIP code.","maxLength":5,"title":"Postalcode","type":"string"}},"required":["postalcode"],"title":"get_sales_tax_by_postal_codeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_account_usage":{"post":{"operationId":"get_account_usage","summary":"Show the key's plan usage this period: requests used, request limit, usage percent and whether the account is active. Us","description":"Show the key's plan usage this period: requests used, request limit, usage percent and whether the account is active. Use for \"How much of my Ziptax request quota have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_tic_codes":{"post":{"operationId":"search_tic_codes","summary":"Search Taxability Information Codes (TICs) by a free-text product description and return ranked matching codes with name","description":"Search Taxability Information Codes (TICs) by a free-text product description and return ranked matching codes with names. Use for \"Which tax code fits 'prepared sandwiches'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Free-text product description, for example 'ceramic pottery kilns' (1 to 1024 characters).","maxLength":1024,"title":"Query","type":"string"}},"required":["query"],"title":"search_tic_codesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_economic_nexus_thresholds":{"post":{"operationId":"list_economic_nexus_thresholds","summary":"List the US state economic nexus thresholds (sales amount, transaction count, how they combine, which sales count, marke","description":"List the US state economic nexus thresholds (sales amount, transaction count, how they combine, which sales count, marketplace treatment, measuring period). Reference data, the same for every caller. Use for \"What is California's economic nexus threshold\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country_code":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":"USA","description":"ISO alpha-3 country code; only USA is published (default USA).","title":"Country Code"}},"title":"list_economic_nexus_thresholdsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}