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

# Describe dataset

> Pass an economic_series source from Search. Select time/value fields and one value for each required dimension before downloading or forecasting. BigQuery description reads metadata without executing SQL.



## OpenAPI

````yaml /docs/api/openapi.json post /v1/market-search/describe
openapi: 3.1.0
info:
  title: Quantura API
  version: 1.0.0
  description: >-
    Search markets and public datasets, download historical observations, create
    forecasts and inspect screener quantiles.
  contact:
    name: Quantura
    url: https://quantura.studio/contact
  license:
    name: Quantura API Terms
    url: https://quantura.studio/terms
servers:
  - url: https://quantura.studio/api
security:
  - bearerAuth: []
  - clerkOAuth:
      - openid
      - profile
      - email
tags:
  - name: Access
  - name: Forecast
  - name: Screener
  - name: Search
  - name: Download
  - name: Scout
paths:
  /v1/market-search/describe:
    servers:
      - url: https://quantura.studio/api
    post:
      tags:
        - Search
      summary: Describe dataset
      description: >-
        Pass an economic_series source from Search. Select time/value fields and
        one value for each required dimension before downloading or forecasting.
        BigQuery description reads metadata without executing SQL.
      operationId: describeQuanturaDataset
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - source
              additionalProperties: false
              properties:
                source:
                  $ref: '#/components/schemas/EconomicSeriesSource'
            example:
              source:
                type: economic_series
                provider: fiscaldata
                series_id: debt_to_penny
      responses:
        '200':
          description: Successful response (illustrative example)
          content:
            application/json:
              schema:
                type: object
              example:
                ok: true
                provider: fiscaldata
                frequency: 1D
                values:
                  - field: tot_pub_debt_out_amt
                    label: Total public debt
                dimensions: []
                units: USD
        '422':
          description: Invalid request or provider unavailable
          content:
            application/json:
              schema:
                type: object
              example:
                ok: false
                error: event_query_invalid
                message: Choose a provider event and a valid continuation cursor.
        '502':
          description: Invalid request or provider unavailable
          content:
            application/json:
              schema:
                type: object
              example:
                ok: false
                error: event_query_invalid
                message: Choose a provider event and a valid continuation cursor.
      security:
        - bearerAuth: []
        - clerkOAuth:
            - openid
            - profile
            - email
components:
  schemas:
    EconomicSeriesSource:
      type: object
      additionalProperties: false
      required:
        - type
        - provider
      properties:
        type:
          const: economic_series
        provider:
          type: string
          enum:
            - fiscaldata
            - worldbank_data360
            - bigquery
        series_id:
          type: string
          enum:
            - debt_to_penny
            - rates_of_exchange
            - avg_interest_rates
            - operating_cash_balance
        table_id:
          type: string
        time_field:
          type: string
        aggregation:
          type: string
          enum:
            - none
            - avg
            - sum
            - min
            - max
        frequency:
          type: string
          enum:
            - 1h
            - 1D
            - 1W-MON
            - 1MS
        value_field:
          type: string
        dataset_id:
          type: string
        indicator_id:
          type: string
        ref_area:
          type: string
        dimensions:
          type: object
          additionalProperties:
            type: string
        limit:
          type: integer
          minimum: 2
          maximum: 50000
          default: 500
        start:
          type: string
        end:
          type: string
      oneOf:
        - properties:
            provider:
              const: fiscaldata
          required:
            - series_id
        - properties:
            provider:
              const: worldbank_data360
          required:
            - dataset_id
            - indicator_id
        - properties:
            provider:
              const: bigquery
          required:
            - dataset_id
            - table_id
      description: >-
        Select one series and one value for every required dimension. Reporting
        periods are daily, month-end, quarter-end, or year-end. Current revised
        data is not a point-in-time vintage. BigQuery history additionally
        requires time_field and value_field, uses only bigquery-public-data,
        exact parameterized filters, a dry run and a 100 MiB billed-byte cap.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Clerk personal API key or legacy Quantura key
    clerkOAuth:
      type: oauth2
      description: >-
        Clerk authorization code with PKCE S256. Pass
        resource=https://quantura.studio on authorization and token requests.
        Paid Pro, enterprise or verified administrator API access is required.
      flows:
        authorizationCode:
          authorizationUrl: https://clerk.quantura.studio/oauth/authorize
          tokenUrl: https://clerk.quantura.studio/oauth/token
          refreshUrl: https://clerk.quantura.studio/oauth/token
          scopes:
            openid: Identify the Quantura account
            profile: Resolve the account profile
            email: Verify account email
            offline_access: Refresh access after expiry

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.