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

# Get an index



## OpenAPI

````yaml /openapi.json get /partner/v1/market/indices/{symbol}
openapi: 3.0.3
info:
  title: Ladder Partner API
  version: v1
  description: >-
    Server-to-server API for licensed partner organisations: KYB, NGN/GHS/USD
    wallets, funding rails, investments and NGX market data, buy and sell
    orders, holdings and webhooks. Every request is HMAC-signed; see the
    Authentication guide.
  contact:
    email: partners@myladder.africa
servers:
  - url: https://api.myladder.africa
    description: Production
  - url: https://api-dev.myladder.africa
    description: UAT (integration and acceptance testing)
security:
  - LadderKey: []
    LadderTimestamp: []
    LadderSignature: []
tags:
  - name: Organisation
    description: The calling organisation and what KYB still needs.
  - name: KYB
    description: >-
      Business information, people, documents, settlement accounts and
      submission.
  - name: Wallets
    description: >-
      Balances, funding requests on every rail, direct-debit mandates and the
      ledger statement.
  - name: Investments
    description: What a partner can buy.
  - name: Market data
    description: >-
      Nigerian Exchange instruments, quotes, bars, indices, FX, calendar and
      disclosures.
  - name: Orders
    description: Buy and sell orders and their lifecycle.
  - name: Holdings
    description: Positions created by completed buys.
  - name: Webhooks
    description: Endpoints, deliveries and retries.
  - name: Sandbox
    description: Test-key only helpers.
paths:
  /partner/v1/market/indices/{symbol}:
    parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Market data
      summary: Get an index
      operationId: market_indices_read
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerInstrumentResponse'
        '401':
          description: Missing/invalid signature, stale timestamp, unknown or revoked key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '403':
          description: IP not allowlisted, or action not allowed for this key/environment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '404':
          description: Not found (or belongs to another organisation/environment).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
        '429':
          description: Rate limited (120 requests/min per key). See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerError'
components:
  schemas:
    PartnerInstrumentResponse:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PartnerMarketInstrument'
    PartnerError:
      required:
        - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PartnerErrorBody'
    PartnerMarketInstrument:
      required:
        - id
        - symbol
        - name
        - currency
        - identifiers
        - listing
        - media
        - ladder
      type: object
      properties:
        id:
          title: Id
          type: string
          format: uuid
        symbol:
          title: Symbol
          type: string
          minLength: 1
        name:
          title: Name
          type: string
          minLength: 1
        asset_class:
          title: Asset class
          description: '`equity`, `fund` or `index`.'
          type: string
          readOnly: true
        security_type:
          title: Security type
          description: '`common_stock`, `etf` or `index`.'
          type: string
          readOnly: true
        exchange:
          title: Exchange
          type: string
          readOnly: true
        currency:
          title: Currency
          type: string
          minLength: 1
        identifiers:
          $ref: '#/components/schemas/PartnerMarketInstrumentIdentifiers'
        listing:
          $ref: '#/components/schemas/PartnerMarketInstrumentListing'
        equity:
          title: Equity
          description: Present for common stock, else null.
          type: string
          readOnly: true
        fund:
          title: Fund
          description: Present for ETFs/ETPs, else null.
          type: string
          readOnly: true
        index:
          title: Index
          description: Present for indices, else null.
          type: string
          readOnly: true
        media:
          $ref: '#/components/schemas/PartnerMarketInstrumentMedia'
        ladder:
          $ref: '#/components/schemas/PartnerMarketInstrumentLadder'
        quote:
          title: Quote
          description: Latest `market.quote`, or null before the first observation.
          type: string
          readOnly: true
    PartnerErrorBody:
      required:
        - code
        - message
        - details
      type: object
      properties:
        code:
          title: Code
          description: Stable machine-readable code, e.g. `insufficient_funds`.
          type: string
          minLength: 1
        message:
          title: Message
          type: string
          minLength: 1
        details:
          title: Details
          description: Code-specific context (validation errors, balances, …).
          type: object
          additionalProperties:
            type: string
            nullable: true
    PartnerMarketInstrumentIdentifiers:
      required:
        - provider
        - provider_ref
      type: object
      properties:
        isin:
          title: Isin
          type: string
          readOnly: true
        provider:
          title: Provider
          type: string
          minLength: 1
        provider_ref:
          title: Provider ref
          type: string
    PartnerMarketInstrumentListing:
      required:
        - status
        - first_seen_at
        - last_seen_at
      type: object
      properties:
        status:
          title: Status
          description: '`active`, or `inactive` once the exchange no longer lists it.'
          type: string
          minLength: 1
        first_seen_at:
          title: First seen at
          type: string
          format: date-time
        last_seen_at:
          title: Last seen at
          type: string
          format: date-time
    PartnerMarketInstrumentMedia:
      type: object
      properties:
        logo_url:
          title: Logo url
          type: string
          readOnly: true
        website:
          title: Website
          type: string
          readOnly: true
    PartnerMarketInstrumentLadder:
      type: object
      properties:
        investment_id:
          title: Investment id
          description: The `investment_id` to use on POST /orders, or null.
          type: string
          readOnly: true
        orderable:
          title: Orderable
          description: True when the linked investment is open to partners.
          type: string
          readOnly: true
  securitySchemes:
    LadderKey:
      type: apiKey
      in: header
      name: X-Ladder-Key
      description: 'Your key id: `pk_test_…` (sandbox) or `pk_live_…` (live).'
    LadderTimestamp:
      type: apiKey
      in: header
      name: X-Ladder-Timestamp
      description: Unix seconds, as a string; must be within 5 minutes of server time.
    LadderSignature:
      type: apiKey
      in: header
      name: X-Ladder-Signature
      description: >-
        Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the
        SHA-256 of the body. See Authentication.

````

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