# Ticksupply API

## Docs

- [Get data availability](https://docs.ticksupply.com/api-reference/availability/get-data-availability.md): Returns data availability information for a specific datastream. Shows time ranges where data is available along with estimated row counts.
- [Get billing summary](https://docs.ticksupply.com/api-reference/billing/get-billing-summary.md): Returns a summary of the account's billing state for the current period: access status, plan code, current period end, and usage totals for streams and exports.
- [List datastreams for exchange](https://docs.ticksupply.com/api-reference/catalog/list-exchange-datastreams.md): Returns all available datastreams for a specific exchange.
- [List exchanges](https://docs.ticksupply.com/api-reference/catalog/list-exchanges.md): Returns a list of all public exchanges available for data subscription.
- [List datastreams for instrument](https://docs.ticksupply.com/api-reference/catalog/list-instrument-datastreams.md): Returns available datastreams for a specific exchange and instrument.
- [List instruments](https://docs.ticksupply.com/api-reference/catalog/list-instruments.md): Returns paginated instruments (trading pairs) for a specific exchange.
- [Create or replace draft](https://docs.ticksupply.com/api-reference/export-schemas/create-draft.md): Creates an unpublished draft for a custom schema so you can iterate on changes without affecting any exports that reference the current published version.
- [Create export schema](https://docs.ticksupply.com/api-reference/export-schemas/create-export-schema.md): Creates a custom export schema with user-defined column mappings. Each column extracts data from system metadata (`meta`) or from per-exchange JSON extraction rules (`data`).
- [Delete export schema](https://docs.ticksupply.com/api-reference/export-schemas/delete-export-schema.md): Deletes a custom export schema. Built-in schemas cannot be deleted.
- [Discard draft](https://docs.ticksupply.com/api-reference/export-schemas/discard-draft.md): Deletes the draft for a custom schema without publishing it. The published version is unaffected.
- [Get draft](https://docs.ticksupply.com/api-reference/export-schemas/get-draft.md): Returns the current draft contents for a custom schema. `version` in the response is the latest published version number (unchanged by drafts); `has_draft` is `true`.
- [Get export schema](https://docs.ticksupply.com/api-reference/export-schemas/get-export-schema.md): Returns a single export schema with its column definitions.
- [List export schemas](https://docs.ticksupply.com/api-reference/export-schemas/list-export-schemas.md): Returns all export schemas available to your account, including built-in schemas and any custom schemas you have created.
- [Publish draft](https://docs.ticksupply.com/api-reference/export-schemas/publish-draft.md): Promotes the current draft to the next published version. `version` is incremented by 1 and `has_draft` becomes `false`.
- [Update draft](https://docs.ticksupply.com/api-reference/export-schemas/update-draft.md): Replaces the contents of an existing draft. The draft must already exist — create one with `POST /v1/export-schemas/{id}/draft` first.
- [Update export schema](https://docs.ticksupply.com/api-reference/export-schemas/update-export-schema.md): Atomically replaces a custom schema's content with a new published version. Increments `version` by 1. Any unpublished draft on the schema is discarded.
- [Cancel export](https://docs.ticksupply.com/api-reference/exports/cancel-export.md): Cancels a queued or running export job. Only exports with status `queued` or `running` can be canceled. This operation is idempotent - canceling an already canceled export succeeds silently.
- [Create export](https://docs.ticksupply.com/api-reference/exports/create-export.md): Creates a new export job for historical data. The export includes data from your subscription spans that overlap with the requested time range.
- [Delete export](https://docs.ticksupply.com/api-reference/exports/delete-export.md): Deletes an export job. The export will no longer appear in list results. This operation is idempotent - deleting an already deleted export succeeds silently.
- [Download export](https://docs.ticksupply.com/api-reference/exports/download-export.md): Generates presigned URLs for downloading export files. URLs are valid for 5 minutes.
- [Get export](https://docs.ticksupply.com/api-reference/exports/get-export.md): Returns details of a specific export job including its current status.
- [List exports](https://docs.ticksupply.com/api-reference/exports/list-exports.md): Returns paginated list of your export jobs.
- [API Reference Overview](https://docs.ticksupply.com/api-reference/overview.md): Complete reference for the Ticksupply REST API
- [Create subscription](https://docs.ticksupply.com/api-reference/subscriptions/create-subscription.md): Creates a new subscription to a data stream. Once created, data collection begins immediately. You can export collected data using the Exports API.
- [Delete subscription](https://docs.ticksupply.com/api-reference/subscriptions/delete-subscription.md): Deletes a subscription. Data collection stops immediately and all recorded spans are removed.
- [Get subscription](https://docs.ticksupply.com/api-reference/subscriptions/get-subscription.md): Returns details of a specific subscription.
- [Get subscription spans](https://docs.ticksupply.com/api-reference/subscriptions/get-subscription-spans.md): Returns the time spans during which data was collected for this subscription. Spans are created when a subscription is activated/resumed and ended when paused/deleted.
- [List subscriptions](https://docs.ticksupply.com/api-reference/subscriptions/list-subscriptions.md): Returns paginated list of your active and paused subscriptions.
- [Pause subscription](https://docs.ticksupply.com/api-reference/subscriptions/pause-subscription.md): Pauses data collection for a subscription. The subscription can be resumed later. This operation is idempotent - pausing an already paused subscription succeeds silently.
- [Resume subscription](https://docs.ticksupply.com/api-reference/subscriptions/resume-subscription.md): Resumes data collection for a paused subscription. This operation is idempotent - resuming an already active subscription succeeds silently.
- [cURL Examples](https://docs.ticksupply.com/examples/curl.md): Complete cURL examples for the Ticksupply API
- [JavaScript Examples](https://docs.ticksupply.com/examples/javascript.md): Complete JavaScript/Node.js examples for the Ticksupply API
- [Python Examples](https://docs.ticksupply.com/examples/python.md): Complete Python examples using the official Ticksupply client library
- [Rust Examples](https://docs.ticksupply.com/examples/rust.md): Complete Rust examples using the official Ticksupply client crate
- [Authentication](https://docs.ticksupply.com/getting-started/authentication.md): Secure your API requests using API key authentication
- [Quickstart](https://docs.ticksupply.com/getting-started/quickstart.md): Get your first data export from Ticksupply in under 5 minutes
- [SDKs & Libraries](https://docs.ticksupply.com/getting-started/sdks.md): Official client libraries for the Ticksupply API
- [Python SDK](https://docs.ticksupply.com/getting-started/sdks/python.md): Official Python client for the Ticksupply API — sync and async, with auto-pagination and typed errors
- [Rust SDK](https://docs.ticksupply.com/getting-started/sdks/rust.md): Official Rust client for the Ticksupply API — async-first, builder pattern, typed errors and wire types
- [Error Handling](https://docs.ticksupply.com/guides/error-handling.md): Handle API errors gracefully in your application
- [Export Schemas](https://docs.ticksupply.com/guides/export-schemas.md): Define custom column mappings to control the shape of your exported data
- [Idempotency](https://docs.ticksupply.com/guides/idempotency.md): Safely retry requests using idempotency keys
- [Pagination](https://docs.ticksupply.com/guides/pagination.md): Navigate large result sets using cursor-based pagination
- [Rate Limiting](https://docs.ticksupply.com/guides/rate-limiting.md): Understand API rate limits and how to handle them in your application
- [Subscription Lifecycle](https://docs.ticksupply.com/guides/subscription-lifecycle.md): States, transitions, and how spans determine what you can export
- [Ticksupply API Documentation](https://docs.ticksupply.com/index.md): Access cryptocurrency market data with the Ticksupply API. Subscribe to real-time data streams, manage subscriptions, and export historical tick data.

## OpenAPI Specs

- [openapi](https://docs.ticksupply.com/openapi.yaml)

## Optional

- [Changelog](https://docs.ticksupply.com/changelog)