T
Tidy
Developer Docs

Guide

SDKs

First-party SDKs for Python and TypeScript, generated from the OpenAPI spec. Both ship typed clients for every endpoint, typed error classes generated from the error catalog, and a webhook signature helper.

Install

pip install tidy-sdk

First call

from tidy_sdk import Tidy
import os

client = Tidy(
    token=os.environ["TIDY_PAT"],
    base_url="https://qa.tidy.engineering",  # default — omit in prod
)

me = client.accounts.me()
print(me.tenant_id, me.is_sandbox)

Features

  • Fully typed — every request and response is a generated TypeScript / Pydantic type. Autocomplete everywhere.
  • Typed errors — catch specific errors (RateLimitExceededError, PolicyBlockedError, etc.) rather than string-matching.
  • Automatic retries — 429 / 503 responses are retried with exponential backoff and jitter per Retry-After.
  • Idempotency keys — writes accept an idempotency_key kwarg; the SDK auto-generates one if omitted.
  • Webhook helper — the same signing verifier shipped on the webhooks page, exported as tidy_sdk.verify_signature (Python) / verifyTidySignature (TypeScript).

Base URL

The default base URL is https://qa.tidy.engineering. Override only for local integration tests or against a self-hosted deployment.

Source