CEF Radar Search API

openapi: 3.2.0
info:
  title: CEF Radar Search API
  description: 'Everything CEF Radar says about a U.S. closed-end fund - who is targeting it, what it is asking holders to do and by when, what it costs, how much it borrows and what it holds - as plain JSON, read from public filings at the U.S. Securities and Exchange Commission. Every fact carries `as_of` and `source_url`; every answer carries a `notice` and a `Link: rel="terms-of-service"` header. Information, not advice. 100 requests a day per address without a key; `Authorization: Bearer ` raises the budget to the plan''s. Assistants have their own server (Model Context Protocol) at https://cefradar.com/mcp; a plain-text guide is at https://cefradar.com/llms.txt.'
  termsOfService: https://cefradar.com/terms#api
  contact:
    name: CEF Radar
    url: https://cefradar.com/for-developers
  license:
    name: CC BY 4.0 (the compiled data; text all rights reserved)
    url: https://creativecommons.org/licenses/by/4.0/
  version: 0.1.0
servers:
- url: https://cefradar.com
tags:
- name: Search
  description: Search-box suggestions and 'which funds hold X'.
paths:
  /api/v1/search:
    get:
      tags:
      - Search
      summary: Up to 6 funds matching a ticker, a name or the firm that runs them (the…
      description: 'Suggestions for the search box: ``[{ticker, name, url}]`` (max 6; ticker exact first). Cached 60 s.'
      operationId: search_funds
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 200
          default: ''
          title: Q
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Search Funds
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/holdings/search:
    get:
      tags:
      - Search
      summary: Which funds hold a company or bond you name (or its CUSIP or ISIN), from the…
      description: 'Which closed-end funds hold a security: ``[{security, cusip, isin, funds: [{ticker, name, pct_val,

        pct_of_holdings, as_of, source_url}]}]`` from every fund''s latest N-PORT (grouped by security, exact name first;

        at most 50 funds per security and 200 fund rows in all). ``pct_val`` is the security''s share of the fund''s NET

        assets as filed (0-100); ``pct_of_holdings`` its share of the fund''s long book (what the site prints), which is

        smaller on funds that borrow.'
      operationId: search_holdings
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 200
          description: company or bond name, CUSIP or ISIN
          default: ''
          title: Q
        description: company or bond name, CUSIP or ISIN
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Search Holdings
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError