Ledger Investing Authentication

generated: '2026-07-19'
method: searched
source: openapi/ledger-investing-analytics-openapi.yml
docs: https://ledger-investing-ledger-analytics.readthedocs-hosted.com/en/stable/apikeys.html
summary:
  types: [apiKey]
  api_key_in: [header]
  oauth2_flows: []
  scopes: none
  mtls: false
schemes:
- name: ApiKeyAuth
  type: apiKey
  in: header
  parameter: Authorization
  value_format: 'Api-Key <API_KEY>'
  description: >-
    The Ledger Analytics API authenticates with a single opaque API key sent in the
    Authorization header using the custom `Api-Key` scheme (not Bearer). There is no OAuth,
    OIDC or mTLS surface. The first-party Python client reads the key from the
    LEDGER_ANALYTICS_API_KEY environment variable and sets the header for every request.
  sources: [openapi/ledger-investing-analytics-openapi.yml]
access:
  status: beta
  request_process: Email analytics@ledgerinvesting.com to sign up for an account and request a key.
  key_management: https://ldgr.app/api-keys
  environment_variables:
  - {name: LEDGER_ANALYTICS_API_KEY, environment: production, host: 'https://api.korra.com/analytics/'}
  - {name: LEDGER_ANALYTICS_DEV_API_KEY, environment: development, note: internal Ledger/Korra development host}
  - {name: LEDGER_ANALYTICS_LOCAL_API_KEY, environment: local, note: localhost development only}
  environment_selector: LEDGER_ANALYTICS_ENV (PROD | DEV | LOCAL, default PROD)
failure_modes:
- {status: 403, meaning: The API key does not have permission to perform this action.}