> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ticksupply.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List export schemas

> Returns all export schemas available to your account, including built-in
schemas and any custom schemas you have created.




## OpenAPI

````yaml get /v1/export-schemas
openapi: 3.1.0
info:
  title: Ticksupply API
  version: 1.0.0
  description: >
    The Ticksupply API provides programmatic access to cryptocurrency market
    data.

    Subscribe to real-time data streams, manage subscriptions, and export
    historical data.
  contact:
    name: Ticksupply Support
    email: support@ticksupply.com
  termsOfService: https://ticksupply.com/terms
  license:
    name: Proprietary
    url: https://ticksupply.com/terms
servers:
  - url: https://api.ticksupply.com
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog
    description: Browse available exchanges, instruments, and data streams
  - name: Subscriptions
    description: Manage data stream subscriptions
  - name: Exports
    description: Export historical data to downloadable files
  - name: Availability
    description: Query data availability for specific streams
  - name: Export Schemas
    description: Manage export column schemas for customized CSV output
  - name: Billing
    description: Inspect your plan, access status, and usage for the current billing period
paths:
  /v1/export-schemas:
    get:
      tags:
        - Export Schemas
      summary: List export schemas
      description: |
        Returns all export schemas available to your account, including built-in
        schemas and any custom schemas you have created.
      operationId: listExportSchemas
      responses:
        '200':
          description: List of export schemas
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportSchemaListItem'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '408':
          $ref: '#/components/responses/RequestTimeout'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: python
          label: Python (ticksupply library)
          source: |
            # pip install ticksupply
            from ticksupply import Client

            client = Client(api_key="<api-key>")
            for schema in client.export_schemas.list():
                print(schema)
        - lang: rust
          label: Rust (ticksupply crate)
          source: |
            // cargo add ticksupply
            // cargo add tokio --features full
            use ticksupply::Client;

            #[tokio::main]
            async fn main() -> ticksupply::Result<()> {
                let client = Client::with_api_key("<api-key>")?;
                for schema in client.export_schemas().list().await? {
                    println!("{schema:#?}");
                }
                Ok(())
            }
components:
  schemas:
    ExportSchemaListItem:
      type: object
      description: >-
        Slim export schema representation returned by the list endpoint (no
        column content).
      allOf:
        - $ref: '#/components/schemas/ExportSchema'
        - type: object
          required:
            - version
            - has_draft
          properties:
            version:
              type: integer
              description: >-
                Latest published version number. `0` if no version has been
                published yet.
              example: 1
            has_draft:
              type: boolean
              description: Whether an unpublished draft version exists for this schema.
              example: false
    ExportSchema:
      type: object
      description: Identity fields shared by every export schema response.
      required:
        - id
        - name
        - stream_category
        - is_built_in
        - created_at
      properties:
        id:
          type: string
          pattern: ^sch_[a-f0-9]{32}$
          description: Export schema ID
          example: sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4
        name:
          type: string
          description: Schema name
          example: normalized
        stream_category:
          type: string
          enum:
            - trade
            - orderbook
            - book_update
            - quote
            - kline
            - ticker
            - liquidation
          description: Stream category this schema applies to
          example: trade
        is_built_in:
          type: boolean
          description: >
            `true` for schemas provided by Ticksupply (e.g., `normalized`,
            `book_5`, `book_20`). Built-ins are read-only and cannot be deleted.
            `false` for schemas you created.
          example: false
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Error code for programmatic handling
              enum:
                - invalid_argument
                - unauthenticated
                - permission_denied
                - not_found
                - already_exists
                - request_timeout
                - rate_limited
                - payment_required
                - internal
                - unavailable
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              description: Additional error details (optional)
  responses:
    Unauthorized:
      description: Missing or invalid API key
      headers:
        X-Request-Id:
          description: Unique request identifier for support inquiries
          schema:
            type: string
            example: req_abc123def456
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: unauthenticated
              message: Invalid or missing API key
    RequestTimeout:
      description: |
        Request did not complete within the 10-second deadline. Retry with
        exponential backoff. If you see this consistently on a particular
        endpoint, contact support.
      headers:
        X-Request-Id:
          description: Unique request identifier for support inquiries
          schema:
            type: string
            example: req_abc123def456
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: request_timeout
              message: Request exceeded 10s deadline
    RateLimited:
      description: Rate limit exceeded
      headers:
        X-Request-Id:
          description: Unique request identifier for support inquiries
          schema:
            type: string
            example: req_abc123def456
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
        X-RateLimit-Limit-Minute:
          description: Maximum requests allowed per minute
          schema:
            type: integer
        X-RateLimit-Remaining-Minute:
          description: Requests remaining in the current minute window
          schema:
            type: integer
        X-RateLimit-Reset-Minute:
          description: >-
            Unix timestamp (seconds) when the minute window next has capacity.
            Included only when the minute bucket is exhausted.
          schema:
            type: integer
        X-RateLimit-Limit-Hour:
          description: Maximum requests allowed per hour
          schema:
            type: integer
        X-RateLimit-Remaining-Hour:
          description: Requests remaining in the current hour window
          schema:
            type: integer
        X-RateLimit-Reset-Hour:
          description: >-
            Unix timestamp (seconds) when the hour window next has capacity.
            Included only when the hour bucket is exhausted.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded. Retry after 30 seconds.
    InternalError:
      description: Internal server error
      headers:
        X-Request-Id:
          description: Unique request identifier for support inquiries
          schema:
            type: string
            example: req_abc123def456
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: internal
              message: An internal error occurred
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key. Get one from the dashboard at
        https://app.ticksupply.com/api-keys

````