> ## 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.

# Get Fund



## OpenAPI

````yaml /openapi.json get /v1/funds/{fund_id}
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/funds/{fund_id}:
    get:
      tags:
        - Funds
      summary: Get Fund
      operationId: get_v1_funds_fund_id
      parameters:
        - name: fund_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Fund Id
        - name: currency
          in: query
          required: false
          schema:
            enum:
              - native
              - NGN
              - USD
            type: string
            description: AUM display currency
            default: native
            title: Currency
          description: AUM display currency
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundRead'
        '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:
    FundRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        provider:
          type: string
          title: Provider
        provider_display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Display Name
        provider_website_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Website Url
        provider_logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Logo Url
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        ticker:
          anyOf:
            - type: string
            - type: 'null'
          title: Ticker
        exchange:
          anyOf:
            - type: string
            - type: 'null'
          title: Exchange
        company_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Company Id
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        base_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Currency
        country_code:
          type: string
          title: Country Code
          default: NG
        is_active:
          type: boolean
          title: Is Active
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        latest_snapshot:
          anyOf:
            - $ref: '#/components/schemas/FundSnapshotRead'
            - type: 'null'
        latest_holdings_snapshot:
          anyOf:
            - $ref: '#/components/schemas/FundSnapshotRead'
            - type: 'null'
      type: object
      required:
        - id
        - provider
        - slug
        - name
        - is_active
      title: FundRead
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    FundSnapshotRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        fund_id:
          type: string
          format: uuid
          title: Fund Id
        as_of_date:
          type: string
          format: date
          title: As Of Date
        factsheet_month:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Factsheet Month
        factsheet_title:
          type: string
          title: Factsheet Title
        factsheet_url:
          type: string
          title: Factsheet Url
        source_post_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Post Url
        source_period_month:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Source Period Month
        source_document_title:
          type: string
          title: Source Document Title
        source_document_url:
          type: string
          title: Source Document Url
        source_page_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Page Url
        source_published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Source Published At
        price:
          anyOf:
            - type: number
            - type: 'null'
          title: Price
        price_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Price Currency
        aum:
          anyOf:
            - type: number
            - type: 'null'
          title: Aum
        aum_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Aum Currency
        native_aum:
          anyOf:
            - type: number
            - type: 'null'
          title: Native Aum
        native_aum_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Native Aum Currency
        fx_rate_applied:
          anyOf:
            - type: number
            - type: 'null'
          title: Fx Rate Applied
        fx_rate_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Fx Rate Date
        aum_conversion_status:
          anyOf:
            - type: string
              enum:
                - native
                - same_currency
                - converted
                - missing_value
                - missing_currency
                - missing_target_currency
                - missing_fx
                - unsupported_currency
            - type: 'null'
          title: Aum Conversion Status
        asset_value_kind:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Value Kind
        asset_value_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Value Label
        month_return_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Month Return Pct
        ytd_return_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Ytd Return Pct
        annual_returns:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Annual Returns
        performance_history:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Performance History
        source_metrics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Source Metrics
        net_yield_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Net Yield Pct
        aum_change_abs:
          anyOf:
            - type: number
            - type: 'null'
          title: Aum Change Abs
        aum_change_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Aum Change Pct
        aum_change_yoy_abs:
          anyOf:
            - type: number
            - type: 'null'
          title: Aum Change Yoy Abs
        aum_change_yoy_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Aum Change Yoy Pct
        price_change_abs:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Change Abs
        price_change_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Change Pct
        price_change_yoy_abs:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Change Yoy Abs
        price_change_yoy_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Change Yoy Pct
        net_yield_change_pct_points:
          anyOf:
            - type: number
            - type: 'null'
          title: Net Yield Change Pct Points
        net_yield_change_yoy_pct_points:
          anyOf:
            - type: number
            - type: 'null'
          title: Net Yield Change Yoy Pct Points
        top_holdings:
          anyOf:
            - items:
                $ref: '#/components/schemas/FundHoldingRead'
              type: array
            - type: 'null'
          title: Top Holdings
      type: object
      required:
        - id
        - fund_id
        - as_of_date
        - factsheet_title
        - factsheet_url
        - source_document_title
        - source_document_url
      title: FundSnapshotRead
    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'
    FundHoldingRead:
      properties:
        name:
          type: string
          title: Name
        weight:
          anyOf:
            - type: number
            - type: 'null'
          title: Weight
        holding_type:
          type: string
          title: Holding Type
        company:
          anyOf:
            - $ref: '#/components/schemas/FundHoldingCompanyRead'
            - type: 'null'
      type: object
      required:
        - name
        - holding_type
      title: FundHoldingRead
    FundHoldingCompanyRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        ticker:
          type: string
          title: Ticker
        name:
          type: string
          title: Name
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
      type: object
      required:
        - id
        - ticker
        - name
      title: FundHoldingCompanyRead
  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.