Daloopa API v3

openapi: 3.0.3
info:
  title: Daloopa API
  version: 2.0.0
  description: Comprehensive API for financial data and analytics
  contact:
    name: Daloopa API Support
    email: api-support@daloopa.com
  license:
    name: Proprietary
paths:
  /api/v3/companies:
    get:
      operationId: companies_list_v3
      description: Retrieve paginated list of companies covered by Daloopa with an
        optional keyword filtering
      summary: List Companies
      parameters:
      - in: query
        name: keyword
        schema:
          type: string
        description: Filter companies by name or ticker symbol (case-insensitive)
        examples:
          SearchByCompanyName:
            value: Apple
            summary: Search by company name
          SearchByTicker:
            value: AAPL
            summary: Search by ticker
      - in: query
        name: limit
        schema:
          type: integer
        description: Number of results to return per page.
      - in: query
        name: offset
        schema:
          type: integer
        description: The initial index from which to return results.
      tags:
      - Companies
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyList'
              examples:
                SuccessfulResponse:
                  value:
                    count: 123
                    next: http://api.example.org/accounts/?offset=400&limit=100
                    previous: http://api.example.org/accounts/?offset=200&limit=100
                    results:
                    - count: 1
                      next: null
                      previous: null
                      results:
                      - id: 2
                        name: Apple Inc.
                        ticker: AAPL
                        industry_: Technology Hardware, Storage & Peripherals
                        sector_: Information Technology
                        actively_maintained: true
                        model_updated_at: '2024-01-15T10:30:00Z'
                        earliest_calendar_quarter: 2020Q1
                        latest_calendar_quarter: 2024Q1
                        earliest_fiscal_quarter: 2020Q1
                        latest_fiscal_quarter: 2024Q1
                        companyidentifier_set:
                        - identifier_type: ISIN
                          identifier_value: US0378331005
                        - identifier_type: CUSIP
                          identifier_value: 037833100
                  summary: Successful response
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/companies/fundamentals:
    get:
      operationId: get_company_fundamentals_v3
      description: Retrieve paginated fundamental financial data for a specific company
        and time periods.
      summary: Get Company Fundamental Data
      parameters:
      - in: query
        name: calendar_periods
        schema:
          type: array
          items:
            type: string
        description: 'List of calendar reporting periods to include. Mutually exclusive
          with `fiscal_periods`. Accepted formats: `YYYYQ[1-4]` (quarters), `YYYYH[1-2]`
          (half-years), or `YYYYFY` (fiscal year). Example: `?calendar_periods=2023Q4&calendar_periods=2024Q1`.'
        explode: true
        style: form
        examples:
          QuarterlyCalendarPeriods:
            value:
            - 2023Q4
            - 2024Q1
            - 2024Q2
            summary: Quarterly Calendar Periods
            description: Recent quarterly calendar periods
      - in: query
        name: company_id
        schema:
          type: integer
        description: The unique identifier of the company.
        required: true
        examples:
          AppleInc.:
            value: 2
            summary: Apple Inc.
            description: Example company ID for Apple Inc.
      - in: query
        name: created_at
        schema:
          type: string
          format: date-time
        description: Minimum creation timestamp (ISO-8601). Used together with `updated_at`
          to form an inclusive range; `created_at` must be ≤ `updated_at`.
        examples:
          CreatedAfter:
            value: '2025-06-01T00:00:00Z'
            summary: Created After
            description: Return records created on/after June 1, 2025 (UTC).
      - in: query
        name: document_id
        schema:
          type: integer
        description: Filter fundamentals to those from a specific document ID.
      - in: query
        name: fiscal_periods
        schema:
          type: array
          items:
            type: string
        description: 'List of fiscal reporting periods to include. Mutually exclusive
          with `calendar_periods`. Accepted formats: `YYYYQ[1-4]` (quarters), `YYYYH[1-2]`
          (half-years), or `YYYYFY` (fiscal year). Example: `?fiscal_periods=2023Q4&fiscal_periods=2024Q1`.'
        explode: true
        style: form
        examples:
          QuarterlyFiscalPeriods:
            value:
            - 2023Q4
            - 2024Q1
            - 2024Q2
            summary: Quarterly Fiscal Periods
            description: Recent quarterly fiscal periods
      - in: query
        name: include_derived
        schema:
          type: boolean
        description: Whether to include derived fundamentals. `true` = include derived
          fundamentals, `false` = exclude derived fundamentals, omit for default behavior
          (excludes derived).
        examples:
          IncludeDerived:
            value: true
            summary: Include Derived
          ExcludeDerived:
            value: false
            summary: Exclude Derived
      - in: query
        name: limit
        schema:
          type: integer
        description: Number of results to return per page.
      - in: query
        name: offset
        schema:
          type: integer
        description: The initial index from which to return results.
      - in: query
        name: restated
        schema:
          type: boolean
        description: Filter by restatement status. `true` = only restated values,
          `false` = only original values, omit to include both.
        examples:
          OnlyRestated:
            value: true
            summary: Only Restated
          OnlyOriginal:
            value: false
            summary: Only Original
      - in: query
        name: sections
        schema:
          type: array
          items:
            type: string
            enum:
            - BALANCE_SHEET
            - CASH_FLOW_STATEMENT
            - DEPRECATED_DATA
            - GAAP_TO_NON_GAAP
            - GEOGRAPHICAL_INFORMATION
            - GUIDANCE
            - INCOME_STATEMENT
            - KPIS
            - OTHER_INFORMATION
            - SEGMENTAL_INFORMATION
        description: Optional list of financial statement sections to filter by. Narrows
          the response to fundamentals whose finantial section matches one of the
          provided values.
        explode: true
        style: form
        examples:
          IncomeStatementAndBalanceSheet:
            value:
            - INCOME_STATEMENT
            - BALANCE_SHEET
            summary: Income Statement and Balance Sheet
            description: Restrict the response to two top-level sections.
      - in: query
        name: series_ids
        schema:
          type: array
          items:
            type: integer
        description: 'Optional list of series IDs to filter by. Example: `?series_ids=101&series_ids=205`.'
        explode: true
        style: form
        examples:
          MultipleSeries:
            value:
            - 101
            - 205
            - 309
            summary: Multiple Series
            description: Filter to a subset of series
      - in: query
        name: unit
        schema:
          type: string
          enum:
          - actual
          - billion
          - million
          - thousand
          - trillion
        description: Optional target unit to convert values to. When omitted, values
          are returned as-reported. Values reported in a currency (e.g. dollars) or
          as a percentage are not convertible and are returned unchanged.
        examples:
          ConvertToMillions:
            value: million
            summary: Convert to millions
            description: Return values scaled to millions.
      - in: query
        name: updated_at
        schema:
          type: string
          format: date-time
        description: Maximum update timestamp (ISO-8601). Used together with `created_at`
          to form an inclusive range; `created_at` must be ≤ `updated_at`.
        examples:
          UpdatedBefore:
            value: '2025-08-01T23:59:59Z'
            summary: Updated Before
            description: Return records updated on/before Aug 1, 2025 (UTC).
      tags:
      - Fundamentals
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFundamentalList'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/documents:
    get:
      operationId: company_document_lookup_v3
      description: Retrieve paginated list of documents for a specific company, optionally
        filtered by quarter and filing type. Use `calendar_quarters` or `fiscal_quarters`
        (repeatable, mutually exclusive) to filter on one or more quarters; `fiscal_quarters`
        are translated to the company's calendar quarters before filtering. Each document
        in the response carries both `calendar_quarter` and `fiscal_quarter`. Results
        are ordered by filing date descending.
      summary: Company Document Lookup
      parameters:
      - in: query
        name: calendar_quarters
        schema:
          type: array
          items:
            type: string
        description: One or more calendar quarters in YYYYQ# format. Repeat the parameter
          to filter on several at once (e.g., ?calendar_quarters=2024Q1&calendar_quarters=2024Q2).
          Mutually exclusive with `fiscal_quarters`.
        explode: true
        style: form
        examples:
          Q12024:
            value:
            - 2024Q1
            summary: Q1 2024
          2024FirstHalf:
            value:
            - 2024Q1
            - 2024Q2
            summary: 2024 first half
      - in: query
        name: company_id
        schema:
          type: integer
        description: The unique identifier of the company.
        required: true
        examples:
          AppleInc.:
            value: 2
            summary: Apple Inc.
            description: Example company ID for Apple Inc.
      - in: query
        name: filing_type
        schema:
          type: string
          enum:
          - 10-K
          - 10-Q
          - 8-K
          - News Article
          - Other
          - Transcript
        description: Type of filing to filter by.
        examples:
          QuarterlyReport:
            value: 10-Q
            summary: Quarterly Report
          AnnualReport:
            value: 10-K
            summary: Annual Report
          CurrentReport:
            value: 8-K
            summary: Current Report
      - in: query
        name: fiscal_quarters
        schema:
          type: array
          items:
            type: string
        description: One or more fiscal quarters in YYYYQ# format. Translated to the
          company's calendar quarters before filtering. Mutually exclusive with `calendar_quarters`.
        explode: true
        style: form
        examples:
          FiscalQ12024:
            value:
            - 2024Q1
            summary: Fiscal Q1 2024
      - in: query
        name: has_fundamentals
        schema:
          type: boolean
        description: When true, restrict the result set to documents that have at
          least one related Fundamentals row. When omitted or false, behavior is unchanged.
        examples:
          OnlyDocumentsWithFundamentals:
            value: true
            summary: Only documents with fundamentals
      - in: query
        name: limit
        schema:
          type: integer
        description: Number of results to return per page.
      - in: query
        name: offset
        schema:
          type: integer
        description: The initial index from which to return results.
      tags:
      - Documents
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentMetadataSerializerV3List'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  details:
                    type: object
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '500':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  message:
                    type: string
          description: ''
  /api/v3/documents/keyword-search:
    post:
      operationId: opensearch_lightweight_search_v3
      description: |-
        Performs keyword search across multiple documents and returns matches without positional information for faster response times.

        **Key Features:**
        - Faster than batch search (no positional data retrieval)
        - Each match includes a unique match_id
        - Use match_id with the positional-info endpoint to get positions on demand
        - Supports same filtering and search options as batch search

        **Use Cases:**
        - Initial search to find relevant documents quickly
        - When positional information is not immediately needed
        - Two-step workflow: search first, then get positions for specific matches

        **Workflow:**
        1. Use this endpoint to quickly find matching documents
        2. Review results and identify matches of interest
        3. Call the positional-info endpoint with match_id for precise locations
      summary: Keyword Search
      tags:
      - Documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchSearchRequestSerializerV3Request'
            examples:
              QuickSearch:
                value:
                  keywords:
                  - operating expenses
                  options:
                    size: 50
                summary: Quick Search
                description: Fast search across documents without positional data
              Multi-companySearch:
                value:
                  keywords:
                  - guidance
                  - outlook
                  filters:
                    company_ids:
                    - 2
                    - 5
                    - 10
                    - 25
                    filing_types:
                    - Transcript
                    - 8-K
                summary: Multi-company Search
                description: Search across multiple companies
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BatchSearchRequestSerializerV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BatchSearchRequestSerializerV3Request'
        required: true
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LightweightBatchSearchResponse'
              examples:
                QuickSearch:
                  value:
                    keywords:
                    - operating expenses
                    options:
                      size: 50
                  summary: Quick Search
                  description: Fast search across documents without positional data
                Multi-companySearch:
                  value:
                    keywords:
                    - guidance
                    - outlook
                    filters:
                      company_ids:
                      - 2
                      - 5
                      - 10
                      - 25
                      filing_types:
                      - Transcript
                      - 8-K
                  summary: Multi-company Search
                  description: Search across multiple companies
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  details:
                    type: object
                example:
                  success: false
                  error: Invalid request parameters
                  details:
                    keywords:
                    - Ensure this field has no more than 10 elements.
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Authentication credentials were not provided.
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: You do not have permission to perform this action.
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                example:
                  detail: Request was throttled. Expected available in 60 seconds.
          description: ''
        '500':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  message:
                    type: string
                example:
                  success: false
                  error: An error occurred during search
                  message: Internal server error
          description: ''
  /api/v3/taxonomy/metrics:
    get:
      operationId: list_taxonomy_metrics_v3
      description: Retrieve a list of all available Taxonomy Metrics. Optionally filter
        by a specific company and series.
      summary: List Taxonomy Metrics
      parameters:
      - in: query
        name: company_id
        schema:
          type: integer
        description: The unique identifier of the company
        examples:
          AppleInc.:
            value: 2
            summary: Apple Inc.
            description: Example company ID for Apple Inc.
      - in: query
        name: keywords
        schema:
          type: array
          items:
            type: string
        description: A list of keywords to filter the KPIs. Maximum of 15 keywords
          allowed.
        examples:
          RevenueAndProfit:
            value:
            - revenue
            - profit
            summary: Revenue and Profit
            description: Example keywords to filter KPIs
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: series_id
        schema:
          type: integer
        description: The unique identifier of the series
        examples:
          IncomeStatement|TotalRevenue:
            value: 1319
            summary: Income Statement | Total Revenue
            description: Example series ID
      tags:
      - Taxonomy
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTaxonomyMetricList'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/taxonomy/metrics/{id}:
    get:
      operationId: retrieve_taxonomy_metric_v3
      description: Retrieve detailed information about a specific Taxonomy Metric
        by its unique identifier.
      summary: Retrieve Taxonomy Metric
      parameters:
      - in: query
        name: company_id
        schema:
          type: integer
        description: The unique identifier of the company
        examples:
          AppleInc.:
            value: 2
            summary: Apple Inc.
            description: Example company ID for Apple Inc.
      - in: path
        name: id
        schema:
          type: integer
        description: The unique identifier of the Taxonomy Metric
        required: true
        examples:
          ExampleMetricID:
            value: 1
            summary: Example Metric ID
            description: An example Metric ID to retrieve details for
      - in: query
        name: industry_id
        schema:
          type: integer
        description: The unique identifier of the industry
      - in: query
        name: sector_id
        schema:
          type: integer
        description: The unique identifier of the sector
      tags:
      - Taxonomy
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxonomyMetricData'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/taxonomy/industry-template/{industry_id}:
    get:
      operationId: retrieve_taxonomy_industry_template_v3
      description: Retrieve an industry template for a given IndustryClassification,
        including associated sectors and active template metrics with associated company
        series.
      summary: Retrieve Taxonomy Industry Template
      parameters:
      - in: path
        name: industry_id
        schema:
          type: integer
        description: The unique identifier of the IndustryClassification
        required: true
        examples:
          ExampleIndustryID:
            value: 1
            summary: Example Industry ID
            description: An example IndustryClassification ID to retrieve a template
              for
      tags:
      - Taxonomy
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxonomyIndustryTemplate'
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/taxonomy/industries:
    get:
      operationId: list_taxonomy_industries
      description: Retrieve Ops industries (IndustryClassification) and their member
        companies. Optionally filter by company_id (returns that company's industry
        and peers) or sector_id.
      summary: List Taxonomy Industries
      parameters:
      - in: query
        name: company_id
        schema:
          type: integer
        description: Return the industry for this company along with peer companies
        examples:
          ExampleCompanyID:
            value: 123
            summary: Example Company ID
            description: An example Company ID to focus industry matches
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: sector_id
        schema:
          type: integer
        description: Filter industries belonging to the specified GICS sector
        examples:
          ExampleSectorID:
            value: 1
            summary: Example Sector ID
            description: An example Ops sector ID
      tags:
      - Taxonomy
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTaxonomyIndustryList'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                  status_code:
                    type: integer
                  message:
                    type: string
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/taxonomy/sectors:
    get:
      operationId: list_taxonomy_sectors
      description: Retrieve Ops sectors and their associated Ops industries (IndustryClassification).
      summary: List Taxonomy Sectors
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - Taxonomy
      security:
      - apiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTaxonomySectorList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
        '429':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
          description: ''
  /api/v3/export/{ticker}:
    get:
      operationId: export_company_model_v3
      description: Export file with company fundamentals metadata for a company as
        Parquet or CSV. Returns Parquet by default; pass `output_format=csv` to receive
        CSV. Supports both historical and real-time data export.
      summary: Export Company Fundamentals
   

# --- truncated at 32 KB (177 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/daloopa/refs/heads/main/openapi/daloopa-api-openapi.yml