Quotelinks API

openapi: 3.1.0
info:
  title: Quotelinks API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 7 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Quotelinks has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 3
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.quotelinks.com/api/exchange-rates
  - https://www.quotelinks.com/api/sec-fundamentals
servers:
- url: https://api.quotelinks.com
paths:
  /v1/company/{id}:
    get:
      operationId: get_v1_company_id
      tags:
      - Company
      summary: 'Company profile: name, tickers, industry, fiscal year end, address, shares outstanding, latest reports.'
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1CompanyIdResponse'
      x-evidence:
        kind: documentation
  /v1/filings/{id}:
    get:
      operationId: get_v1_filings_id
      tags:
      - Filings
      summary: SEC filings, newest first, with links to the documents on sec.gov; filter by form and date.
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: form
        in: query
        required: false
        schema:
          type: string
        description: Comma‑separated form types, e.g. 10‑K,10‑Q,8‑K. Exact match; amendments are separate types (10‑K/A).
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: Filing date range start (YYYY‑MM‑DD), inclusive.
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: Filing date range end (YYYY‑MM‑DD), inclusive.
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Filings per page, 1–1000. Default 100.
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: Skip this many filings. Use the next URL in the response to page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1FilingsIdResponse'
      x-evidence:
        kind: documentation
  /v1/financials/{id}:
    get:
      operationId: get_v1_financials_id
      tags:
      - Financials
      summary: Standardized financial statements, one entry per period, newest first.
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: period
        in: query
        required: false
        schema:
          type: string
        description: annual (default), quarterly (Q1–Q4) or ttm (trailing twelve months, one entry per quarter end).
      - name: basis
        in: query
        required: false
        schema:
          type: string
        description: 'latest (default): the most recently filed figure for each period, adjusted for stock splits. original : the figure as first
          reported, never adjusted. ttm is only available with latest.'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1FinancialsIdResponse'
      x-evidence:
        kind: documentation
  /v1/fx/history/{currency}:
    get:
      operationId: get_v1_fx_history_currency
      tags:
      - Fx
      summary: The full daily history of one currency since 1999.
      x-source: https://www.quotelinks.com/api/exchange-rates
      parameters:
      - name: currency
        in: path
        required: true
        schema:
          type: string
      - name: base
        in: query
        required: false
        schema:
          type: string
        description: 'Base currency. Default EUR. Alias: from.'
      - name: amount
        in: query
        required: false
        schema:
          type: string
        description: Amount of the base currency to convert. Default 1.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1FxHistoryCurrencyResponse'
      x-evidence:
        kind: documentation
  /v1/industries/{sic}:
    get:
      operationId: get_v1_industries_sic
      tags:
      - Industries
      summary: Companies in one SIC industry with their latest annual revenue, net income and total assets.
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      parameters:
      - name: sic
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1IndustriesSicResponse'
      x-evidence:
        kind: documentation
  /v1/status:
    get:
      operationId: get_v1_status
      tags:
      - Status
      summary: When the data was last rebuilt, and how many companies it covers.
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1StatusResponse'
      x-evidence:
        kind: documentation
  /v1/tickers:
    get:
      operationId: get_v1_tickers
      tags:
      - Tickers
      summary: Every ticker with its CIK, company name and exchange.
      x-source: https://www.quotelinks.com/api/sec-fundamentals
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1TickersResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetV1CompanyIdResponse:
      type: object
      properties:
        cik:
          type: integer
        symbol:
          type: string
        tickers:
          type: array
          description: List of ticker objects with symbol and exchange
        name:
          type: string
        entity_type:
          type: string
        category:
          type: string
        industry:
          type: object
        fiscal_year_end:
          type: string
        state_of_incorporation:
          type: string
        phone:
          type: string
        address:
          type: object
        former_names:
          type: array
        shares_outstanding:
          type: object
        public_float:
          type: object
        latest_annual_report:
          type: object
        latest_quarterly_report:
          type: object
        filings_count:
          type: integer
        financials:
          type: object
    GetV1FilingsIdResponse:
      type: object
      properties:
        cik:
          type: integer
        symbol:
          type: string
        name:
          type: string
        count:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        next:
          type: string
        filings:
          type: array
          description: Array of filing objects with accession, form, filed, report_date, accepted, items, primary_document, description, size,
            xbrl, inline_xbrl, url, index_url.
    GetV1FinancialsIdResponse:
      type: object
      properties:
        cik:
          type: integer
          description: SEC CIK number
        symbol:
          type: string
          description: Ticker symbol
        name:
          type: string
          description: Company name
        currency:
          type: string
          description: Reporting currency
        period:
          type: string
          description: Requested period type
        basis:
          type: string
          description: Basis of figures
        fields:
          type: object
          description: Metadata about each financial field
        periods:
          type: array
          description: Array of period objects, each containing fiscal_year, fiscal_period, start, end, form, filed, accession and the 39 financial
            fields plus sources and notes.
    GetV1FxHistoryCurrencyResponse:
      type: object
      properties:
        amount:
          type: string
          description: Amount used for conversion.
        base:
          type: string
          description: Base currency of the rates.
        start_date:
          type: string
          description: First date in the history.
        end_date:
          type: string
          description: Last date in the history.
        rates:
          type: string
          description: Object mapping each date to a sub‑object with the requested currency rate.
    GetV1IndustriesSicResponse:
      type: object
      properties:
        sic:
          type: integer
        title:
          type: string
        division:
          type: string
        division_title:
          type: string
        major_group:
          type: string
        count:
          type: integer
        companies:
          type: array
          description: Array of company objects with cik, symbol, name, fiscal_year, fiscal_year_end, current, currency, revenue, net_income,
            total_assets.
    GetV1StatusResponse:
      type: object
      properties:
        status:
          type: string
        service:
          type: string
        version:
          type: string
        source:
          type: string
        build:
          type: string
        built:
          type: string
        sec_files:
          type: object
        counts:
          type: object
          description: Counts of companies, tickers, companies_with_financials, industries.
    GetV1TickersResponse:
      type: object
      properties:
        count:
          type: integer
        tickers:
          type: array
          description: Array of ticker objects with symbol, cik, name, exchange, primary.
  securitySchemes:
    api_token:
      type: apiKey
      in: query
      name: Authorization
      x-source: https://www.quotelinks.com/api/key/
tags:
- name: Company
- name: Filings
- name: Financials
- name: Fx
- name: Industries
- name: Status
- name: Tickers
security:
- api_token: []