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.

Support Log In Sign Up

Guides API Reference

Guides API Reference

Tax Rates
- GETGet Tax Rates (v5.0)
Account
- GETGet Account Metrics (v5.0)
Data
System
- GETHealth Check
- GETGet System Metadata

Support Log In Sign Up

Get Account Metrics (v5.0)

GET

/account/v50/metrics

GET

/account/v50/metrics

$ curl https://api.ziptax.com/account/v50/metrics \
>      -H "X-API-KEY: <apiKey>"

1 {
2   "core_request_count": 1,
3   "core_request_limit": 1,
4   "core_usage_percent": 1.1,
5   "geo_enabled": true,
6   "geo_request_count": 1,
7   "geo_request_limit": 1,
8   "geo_usage_percent": 1.1,
9   "is_active": true,
10   "last_updated": "2024-01-15T09:30:00Z"
11 }

Returns usage metrics for the authenticated account

Was this page helpful?

Get TIC Codes

Authentication

X-API-KEYstring

API key in header

Query parameters

keystringOptional10-100 characters

API key for authentication

Response

OK

core_request_countlong

Core request count

core_request_limitlong

Core request limit

core_usage_percentdouble

Core usage percentage

geo_enabledboolean

Geo features enabled

geo_request_countlong

Geo request count

geo_request_limitlong

Geo request limit

geo_usage_percentdouble

Geo usage percentage

is_activeboolean

Account active status

last_updatedstringformat: "date-time"

Last update timestamp

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error