DilutionLens Company API

openapi: 3.2.0
info:
  title: Dilutionlens Com Company API
  version: 1.0.0
  description: 'Operations tagged Company across 2 of this provider''s published API definitions: dilutionlens-com-openapi.json, dilutionlens-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dilutionlens.com
tags:
- name: Company
paths:
  /api/v1/company/{ticker}/snapshot:
    get:
      summary: Free dilution snapshot for one company
      description: 'Headline metrics as shown on the free company page: dilution risk level, cash cover band, market cap, industry, 12-month raise count, max dilution percent, and a link to the page. Works without a key (~20 calls/day per caller, per UTC day).'
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - {}
      - apiKey: []
      responses:
        '200':
          description: The snapshot.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/badRequest'
        '429':
          $ref: '#/components/responses/rateLimited'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerSnapshot
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/raises:
    get:
      summary: Every capital raise on record for one company (paid)
      description: 'Identical to the paid company page''s raise history: every raise with date, type, amount and per-raise detail, cited to the source announcements.'
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The raise history.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerRaises
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/options:
    get:
      summary: The option and convertible register for one company (free; deeper with a paid…
      description: 'Without a key: options_register — every line''s code, type (price-triggered, condition-triggered, converts on terms, not classified), exercise price, expiry and quantity, identical to the free company page, ~20 calls/day per IP. With a paid key the same call also returns options (each line''s in-the-money value, the filing''s description and section, and the quantities and strikes as filed before any consolidation rebase) and options_consolidation_adjusted, identical to the paid page''s options block.'
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - {}
      - apiKey: []
      responses:
        '200':
          description: The register, plus the paid detail when the key entitles it.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerOptions
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/cash:
    get:
      summary: Quarterly cash and runway history for one company (paid)
      description: 'Identical to the paid company page''s cash detail (IQ Cash): quarterly figures and cover, for companies that file quarterly cash reports.'
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The cash history.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerCash
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/timeline:
    get:
      summary: The share-issuance timeline for one company (paid)
      description: Every issuance-relevant filing for the company, dated and cited — identical to the paid company page's timeline.
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The timeline.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerTimeline
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/insiders:
    get:
      summary: Director dealing notices for one company (paid)
      description: Identical to the paid company page's dealings block, cited to the filings.
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The dealing notices.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerInsiders
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/raises.csv:
    get:
      summary: Every capital raise on record for one company, as CSV (paid)
      description: 'The rows of /api/v1/company/{ticker}/raises, serialised as CSV. Columns are that endpoint''s own JSON field names, one row per raise. The response carries Content-Disposition: attachment with the filename -raises-.csv, dated by the build the rows came from rather than by the download. Per-ticker only, and counted against the same shared budget as every other keyed call.'
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The CSV file. An empty body means the company has no rows on record.
          content:
            text/csv:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerRaisesCsv
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/options.csv:
    get:
      summary: Every option and convertible line for one company, as CSV (paid)
      description: The rows of /api/v1/company/{ticker}/options, serialised as CSV. Where the lines are adjusted for a share consolidation, a consolidation_adjusted column carries that fact — the same caveat the page prints above the table. Content-Disposition names the file -options-.csv. Per-ticker only.
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The CSV file. An empty body means the company has no rows on record.
          content:
            text/csv:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerOptionsCsv
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
  /api/v1/company/{ticker}/timeline.csv:
    get:
      summary: The share-issuance timeline for one company, as CSV (paid)
      description: The rows of /api/v1/company/{ticker}/timeline, serialised as CSV. Columns are that endpoint's own JSON field names, one row per filing. The timeline itself is capped at the 200 most recent issuance filings, so a company with a longer history exports those 200 and not its whole record — the JSON endpoint and the website's own table carry exactly the same 200. Content-Disposition names the file -timeline-.csv. Per-ticker only.
      parameters:
      - $ref: '#/components/parameters/ticker'
      security:
      - apiKey: []
      responses:
        '200':
          description: The CSV file. An empty body means the company has no rows on record.
          content:
            text/csv:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/unauthorized'
        '402':
          $ref: '#/components/responses/paymentRequired'
        '429':
          $ref: '#/components/responses/rateLimited'
        '400':
          $ref: '#/components/responses/badRequest'
      tags:
      - Company
      operationId: getApiV1CompanyByTickerTimelineCsv
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
components:
  responses:
    badRequest:
      description: Unknown ticker, unknown section, or a bulk-shaped request (error code per_ticker_only, answered with the professional contact address).
    paymentRequired:
      description: 'This endpoint is part of a paid plan (error code unlock_required). Plans: https://dilutionlens.com/pricing/'
    rateLimited:
      description: The shared per-account budget (or the free daily cap) is spent. Hourly budgets reset at the top of the hour; the free cap resets at midnight UTC.
    unauthorized:
      description: Missing, unknown or revoked API key. The body carries an error code (auth_required | invalid_key).
  parameters:
    ticker:
      name: ticker
      in: path
      required: true
      schema:
        type: string
        pattern: ^[A-Za-z0-9]{2,8}$
      description: One ASX ticker code, e.g. BHP.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Created and revoked at https://dilutionlens.com/account/. Shown once at creation; stored hashed.
x-refined-from:
- dilutionlens-com-openapi.json
- dilutionlens-com-openapi.yml