DilutionLens Screen API

openapi: 3.2.0
info:
  title: Dilutionlens Com Screen API
  version: 1.0.0
  description: 'Operations tagged Screen 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: Screen
paths:
  /api/v1/screen:
    get:
      summary: Screen the market (paid, top 20 rows)
      description: 'Filter and sort the universe by dilution risk, cash cover band, market-cap band, industry or name. Returns at most 20 rows — always the TOP rows of the requested ordering; there is no offset paging on this endpoint (an explicit offset, or a limit above 20, is ignored and reported in the response''s ignored list). A discovery tool, not an extract. Query parameters match the public screener''s URL vocabulary: q, risk, cover, cap, industry, suspended, sort, dir. Companies suspended from official quotation are EXCLUDED by default, exactly as on the website; the response''s suspended_hidden says how many this query withheld, and suspended=include returns them.'
      parameters:
      - name: q
        in: query
        schema:
          type: string
        description: Name or ticker search.
      - name: risk
        in: query
        schema:
          type: string
        description: Very high | High | Moderate | Low | Minimal | Not rated.
      - name: cover
        in: query
        schema:
          type: string
        description: <2q | 2-4q | 4+q | na.
      - name: cap
        in: query
        schema:
          type: string
        description: nano | micro | small | mid | large | na.
      - name: industry
        in: query
        schema:
          type: string
      - name: suspended
        in: query
        schema:
          type: string
        description: include — return companies suspended from official quotation, which are excluded by default.
      - name: sort
        in: query
        schema:
          type: string
        description: risk | cover | mktcap | raises | ticker | name | industry | itm | pending | expiry | short.
      - name: dir
        in: query
        schema:
          type: string
        description: asc | desc.
      security:
      - apiKey: []
      responses:
        '200':
          description: Up to 20 matching rows, the honest total, and suspended_hidden — the number of suspended companies this query withheld.
          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:
      - Screen
      operationId: getApiV1Screen
      x-operation-id-source: derived
    servers:
    - url: https://dilutionlens.com
components:
  responses:
    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).
    badRequest:
      description: Unknown ticker, unknown section, or a bulk-shaped request (error code per_ticker_only, answered with the professional contact address).
  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