CEF Radar Funds API

openapi: 3.2.0
info:
  title: CEF Radar Funds 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: Funds
  description: 'U.S. closed-end funds: the list, one fund, its facts, holdings and announcements.'
paths:
  /api/v1/funds:
    get:
      tags:
      - Funds
      summary: Every U.S.
      operationId: list_funds
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 100
          title: Per Page
      - name: activist
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 1 = only funds with an active activist stake
          title: Activist
        description: 1 = only funds with an active activist stake
      - name: sponsor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: sponsor short name, e.g. Nuveen
          title: Sponsor
        description: sponsor short name, e.g. Nuveen
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: category slug, e.g. municipal
          title: Category
        description: category slug, e.g. municipal
      - name: sort
        in: query
        required: false
        schema:
          type: string
          description: ticker | name | cost | borrowing | size
          default: ticker
          title: Sort
        description: ticker | name | cost | borrowing | size
      - name: dir
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'asc | desc (default: asc for ticker/name, desc for numbers)'
          title: Dir
        description: 'asc | desc (default: asc for ticker/name, desc for numbers)'
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: substring of name/ticker
          title: Q
        description: substring of name/ticker
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Funds
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/funds/{ticker}:
    get:
      tags:
      - Funds
      summary: 'One fund: the investors in it, its latest notices and announcements, and a…'
      operationId: get_fund
      parameters:
      - name: ticker
        in: path
        required: true
        schema:
          type: string
          title: Ticker
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Fund
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/funds/{ticker}/facts:
    get:
      tags:
      - Funds
      summary: One fund's latest yearly, quarterly and annual-report facts, each with its…
      description: 'Latest yearly (N-CEN), quarterly (N-PORT) and annual-report (inline XBRL) facts; each with as_of + source_url.

        ``facts.shares_outstanding`` is computed from the annual report''s own table (year-end net assets / value per share,

        gated against the quarterly report); each ``years[]`` row carries the count the parser read as

        ``shares_outstanding_parsed`` with ``shares_outstanding_parsed_agrees`` - a cross-check, not the figure (some

        reports print it in thousands or for a sibling fund).'
      operationId: get_fund_facts
      parameters:
      - name: ticker
        in: path
        required: true
        schema:
          type: string
          title: Ticker
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Fund Facts
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/funds/{ticker}/holdings:
    get:
      tags:
      - Funds
      summary: One fund's top 25 holdings and its mix by type of holding, kind of borrower and…
      description: Top 25 positions and the asset / issuer / country mix from the latest quarterly holdings report.
      operationId: get_fund_holdings
      parameters:
      - name: ticker
        in: path
        required: true
        schema:
          type: string
          title: Ticker
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Fund 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