> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rangler.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List Company Dividends

> Requires paid access.



## OpenAPI

````yaml /openapi.json get /v1/companies/{company_id}/dividends
openapi: 3.1.0
info:
  title: Rangler API
  version: 1.0.0
  description: >-
    Customer-facing Rangler API for companies, standardized financials, filings,
    funds, market data, events, and webhooks.
servers:
  - url: https://api.rangler.co
    description: Live
  - url: https://sandbox-api.rangler.co
    description: Sandbox
security: []
tags:
  - name: Analyst estimates
    description: Consensus forecasts, revisions, contributor accuracy, and source evidence.
  - name: Analyst recommendations
    description: Analyst ratings, target-price views, and company recommendation history.
  - name: Calendar
    description: Company events and calendar exports.
  - name: Companies
    description: >-
      Company lookup, issuer details, dividends, daily trades, meeting media,
      and mentions.
  - name: Events
    description: >-
      Read earlier events and check for missed deliveries across the market, a
      company, or a fund.
  - name: Financials
    description: >-
      Standardized financial statements, reported tables, ratios, and links to
      filing sources.
  - name: Filings
    description: Filings, board changes, insider dealings, and extracted filing mentions.
  - name: Funds
    description: Fund directories, disclosures, snapshots, holdings, and performance data.
  - name: Markets
    description: Market directories and regular-session clock data.
  - name: News
    description: Company news developments and company-filtered news search.
paths:
  /v1/companies/{company_id}/dividends:
    get:
      tags:
        - Companies
      summary: List Company Dividends
      description: Requires paid access.
      operationId: get_v1_companies_company_id_dividends
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Company Id
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 250
            minimum: 1
            default: 100
            title: Limit
        - name: yield_as_of
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: >-
              Date used for the YTD dividend-yield summary; defaults to the
              latest available price.
            title: Yield As Of
          description: >-
            Date used for the YTD dividend-yield summary; defaults to the latest
            available price.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDividendsPage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: unauthorized
                      code: unauthorized
                      message: Authentication required.
                      request_id: 28fa6152-7081-492e-8a7e-00beb237b689
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: forbidden
                      code: forbidden
                      message: Paid access is required.
                      request_id: 5c253b3e-778e-4a58-aaf8-07cb21e03563
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: not_found
                      code: not_found
                      message: Company not found
                      request_id: 9f5237bc-7d8c-4a9d-9c1f-fbd4ef236cf9
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: validation_error
                      code: validation_error
                      message: Request validation failed
                      request_id: c5964dca-d290-4465-a3dc-f92d42aa9b17
                      details:
                        - type: missing
                          loc:
                            - query
                            - ticker
                          msg: Field required
                          input: null
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: rate_limit_exceeded
                      code: rate_limit_exceeded
                      message: Rate limit exceeded
                      request_id: cc4d369a-2c69-4ee2-909e-985ea35d14a9
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: internal_server_error
                      code: internal_server_error
                      message: Internal Server Error
                      request_id: 70b63aba-b8a3-41c2-bb0c-fbe67d84d37d
      security:
        - RanglerApiKey: []
components:
  schemas:
    CompanyDividendsPage:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CompanyDividendRead'
          type: array
          title: Data
        ytd_yield:
          anyOf:
            - $ref: '#/components/schemas/CompanyDividendYieldSummaryRead'
            - type: 'null'
      type: object
      required:
        - data
      title: CompanyDividendsPage
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    CompanyDividendRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        dividend_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Dividend Type
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        declaration_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Declaration Date
        qualification_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Qualification Date
        agm_approval_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Agm Approval Date
        closure_start_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Closure Start Date
        closure_end_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Closure End Date
        payment_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Payment Date
        gross:
          anyOf:
            - type: number
            - type: 'null'
          title: Gross
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        gross_converted:
          anyOf:
            - type: number
            - type: 'null'
          title: Gross Converted
          description: >-
            Gross per share converted to the listing market currency on the
            declaration date.
        gross_converted_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Gross Converted Currency
        gross_conversion_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Gross Conversion Rate
        gross_conversion_rate_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Gross Conversion Rate Date
        fiscal_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fiscal Year
        period_end_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Period End Date
        yield_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Yield Pct
        yield_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Yield Currency
        yield_fx_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Yield Fx Rate
        yield_fx_rate_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Yield Fx Rate Date
        source_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Ref
        filing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Filing Id
        filing_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Title
        filing_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Url
        source_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Page
        source_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Excerpt
        revision_number:
          type: integer
          title: Revision Number
          default: 0
        sources:
          items:
            $ref: '#/components/schemas/CompanyDividendSourceRead'
          type: array
          title: Sources
        revisions:
          items:
            $ref: '#/components/schemas/CompanyDividendRevisionRead'
          type: array
          title: Revisions
      type: object
      required:
        - id
      title: CompanyDividendRead
    CompanyDividendYieldSummaryRead:
      properties:
        period:
          type: string
          title: Period
          default: YTD
        year:
          type: integer
          title: Year
        as_of_date:
          type: string
          format: date
          title: As Of Date
        price_date:
          type: string
          format: date
          title: Price Date
        total_gross:
          type: number
          title: Total Gross
        currency:
          type: string
          title: Currency
        price:
          type: number
          title: Price
        yield_pct:
          type: number
          title: Yield Pct
        included_dividend_count:
          type: integer
          title: Included Dividend Count
        converted_dividend_count:
          type: integer
          title: Converted Dividend Count
          default: 0
        excluded_dividend_count:
          type: integer
          title: Excluded Dividend Count
          default: 0
      type: object
      required:
        - year
        - as_of_date
        - price_date
        - total_gross
        - currency
        - price
        - yield_pct
        - included_dividend_count
      title: CompanyDividendYieldSummaryRead
    ErrorObject:
      type: object
      required:
        - type
        - code
        - message
        - request_id
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: array
              items:
                additionalProperties: true
                type: object
            - type: 'null'
    CompanyDividendSourceRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        source_kind:
          type: string
          title: Source Kind
        source_ref:
          type: string
          title: Source Ref
        filing_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Filing Id
        filing_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Title
        filing_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Url
        source_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Page
        source_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Excerpt
        source_published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Source Published At
      type: object
      required:
        - id
        - source_kind
        - source_ref
      title: CompanyDividendSourceRead
    CompanyDividendRevisionRead:
      properties:
        revision_number:
          type: integer
          title: Revision Number
        changed_fields:
          items:
            type: string
          type: array
          title: Changed Fields
        recorded_at:
          type: string
          format: date-time
          title: Recorded At
      type: object
      required:
        - revision_number
        - changed_fields
        - recorded_at
      title: CompanyDividendRevisionRead
  securitySchemes:
    RanglerApiKey:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.