> ## 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.

# Get export

> Returns details of a specific export job including its current status.



## OpenAPI

````yaml get /v1/exports/{id}
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/exports/{id}:
    get:
      tags:
        - Exports
      summary: Get export
      description: Returns details of a specific export job including its current status.
      operationId: getExport
      parameters:
        - name: id
          in: path
          required: true
          description: Export job ID (prefixed format, e.g., exp_xxx)
          schema:
            type: string
            pattern: ^exp_[a-f0-9]{32}$
          example: exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4
      responses:
        '200':
          description: Export job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJob'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '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>")
            job = client.exports.get("exp_019478a23c5f7b8e9d12abcdef012345")
            print(job)
        - 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>")?;
                let job = client.exports()
                    .get("exp_019478a23c5f7b8e9d12abcdef012345")
                    .await?;
                println!("{job:#?}");
                Ok(())
            }
components:
  schemas:
    ExportJob:
      type: object
      required:
        - id
        - datastream_id
        - start_time
        - end_time
        - format
        - format_options
        - status
        - created_at
      properties:
        id:
          type: string
          pattern: ^exp_[a-f0-9]{32}$
          description: Prefixed export job ID (e.g., exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4)
          example: exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4
        datastream_id:
          type: integer
          format: int64
          description: Datastream ID being exported
          example: 123
        start_time:
          type: integer
          format: int64
          description: Start of data range (nanoseconds since Unix epoch)
          example: 1704067200000000000
        end_time:
          type: integer
          format: int64
          description: End of data range (nanoseconds since Unix epoch)
          example: 1704153600000000000
        format:
          $ref: '#/components/schemas/ExportFormat'
        format_options:
          description: >
            Server-resolved per-format options, echoed back with every default
            filled in.

            The shape matches `format`: empty object for `csv`, a populated

            `ParquetFormatOptions` for `parquet`. Pin these values in your
            client to keep

            future server default changes from affecting your pipeline.
          oneOf:
            - $ref: '#/components/schemas/CsvFormatOptions'
            - $ref: '#/components/schemas/ParquetFormatOptions'
        status:
          $ref: '#/components/schemas/ExportStatus'
        reason:
          type: string
          nullable: true
          description: Failure reason (only present when status is "failed")
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        started_at:
          type: string
          format: date-time
          nullable: true
          description: When processing started
        finished_at:
          type: string
          format: date-time
          nullable: true
          description: When processing finished
    ExportFormat:
      type: string
      enum:
        - csv
        - parquet
      description: >
        Output container format.


        - `csv` — gzip-compressed CSV with a header row (`.csv.gz`). Type
        information
          is lost; consumers parse strings.
        - `parquet` — columnar Parquet (`.parquet`). Preserves ClickHouse types
          (Decimal, DateTime64(9), Nullable, Array → LIST), supports per-column
          compression, and is read efficiently by pandas, Polars, DuckDB, Athena, and Spark.
    CsvFormatOptions:
      type: object
      additionalProperties: false
      description: >
        Reserved for future CSV-specific options. Currently must be empty or
        omitted —

        any keys are rejected.
    ParquetFormatOptions:
      type: object
      additionalProperties: false
      description: Per-format options applied when `format=parquet`.
      properties:
        compression:
          type: string
          enum:
            - snappy
            - zstd
            - gzip
            - lz4
            - none
          default: zstd
          description: >
            Compression codec applied per column. Server default is `zstd`

            (best ratio, broadly supported by Arrow / pandas / Polars / DuckDB /
            Athena / Spark).

            Pick `snappy` for faster reads, `none` to disable compression
            entirely.
    ExportStatus:
      type: string
      enum:
        - queued
        - running
        - succeeded
        - failed
        - canceled
      description: Export job status
    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
    NotFound:
      description: Resource not found
      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: not_found
              message: Subscription not found
    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

````