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
    • Welcome to Ziptax
      • Quickstart
      • How to create an API key
      • How to find a TIC
      • Overview
      • Claude Skill
      • MCP Server
      • OpenAPI Spec
Logo
SupportLog InSign Up
On this page
  • What you can do with it
  • Authentication
Agents & LLMs

Machine-Readable OpenAPI Spec

The canonical OpenAPI v3 document for the Ziptax API
Was this page helpful?
Previous

Taxability Information Codes (TICs)

Product-specific tax rules for clothing, food, software, and more

Next
Built with

The official Ziptax API specification is published in OpenAPI v3 JSON format and is always available at the URL below. This document is the authoritative source of truth for every endpoint, authentication method, request parameter, response schema, and error code in the Ziptax platform.

openapi.json

Canonical machine-readable spec. Always up to date.

What you can do with it

The spec is designed for both humans and autonomous tooling:

  • Load it into Swagger UI, Redoc, or Postman to explore the API interactively.
  • Feed it to openapi-generator or any SDK generator to produce a type-safe client in your language of choice.
  • Hand it to an AI agent or LLM that needs to understand request structure, authentication headers (X-API-KEY), and response shape before generating integration code.
  • Use it to power contract tests against your own integration.

Authentication

All endpoints described in the spec authenticate via a single header:

1X-API-KEY: your-api-key

Some endpoints additionally accept the API key as a key= query parameter, but the header is preferred for production use.

The spec is regenerated automatically from the Ziptax API source of truth, so bookmarking the raw URL above guarantees you always have the latest contract.