Skip to main content

Introduction

Every endpoint is documented with its parameters, request and response schemas, error codes and examples you can run straight from the browser ("Try it"). The reference is grouped by domain:

  • Authentication — get the JWT token that signs every other call.
  • Holdings — instrument positions, mutual fund shares and cash balances of the investment account.
  • Current account — movements and balances.
  • Instruments — catalogs and reference data.
  • Mutual funds — data of a fund by its CAFCI code.

OpenAPI specification​

The full contract is published as a single OpenAPI 3.1 file:

⬇ Download openapi.yaml

Canonical URL: https://api-docs.max.capital/openapi/openapi.yaml

It is the same source this reference is built from, so there is no gap between what you read here and what your code consumes. Use it to:

  • generate a client in your language (openapi-generator, oapi-codegen, NSwag, etc.);
  • import the API into Postman, Insomnia or Bruno and build your collection;
  • validate payloads against the schemas in your tests.

The file's servers field declares the development Base URL: that is the environment "Try it" runs against. The Base URL for each environment is listed in Conventions.

Before you start​

  • Credentials are environment-specific. Need the development ones? Get in touch.
  • The Quickstart takes you from zero to your first call.
  • The rules that apply to every endpoint — versioning, date format, error structure and rate limits — are in Conventions.