# Matamba Gateway

> Trade Nigerian equities for your customers through one API: accounts, funding, orders and positions at a licensed broker.

- [Matamba Gateway](https://docs.matambaintelligence.com/index.md): Open brokerage accounts for your customers, fund them, and trade Nigerian equities on their behalf with one API.
- [Quickstart](https://docs.matambaintelligence.com/quickstart.md): Place your first order in the sandbox and see the resulting position.
- [How it works](https://docs.matambaintelligence.com/how-it-works.md): What happens to a request, and the rules every endpoint follows.
- [Orders](https://docs.matambaintelligence.com/orders.md): The states an order moves through, the rules for each order type, and how cancels and fills reach you.
- [Idempotency](https://docs.matambaintelligence.com/idempotency.md): Retry a request safely, so one order never becomes two.
- [Wallet](https://docs.matambaintelligence.com/wallet.md): How your wallet is funded, how you allocate from it to your customers' accounts, and what its four figures mean.
- [Webhooks](https://docs.matambaintelligence.com/webhooks.md): Receive order events at your HTTPS endpoint, check that each one came from us, and catch up on any you missed.
- [Handling uncertain orders](https://docs.matambaintelligence.com/handling-uncertain.md): What to do when we don't know whether the exchange received an order.
- [Go-live checklist](https://docs.matambaintelligence.com/go-live.md): What to check before you switch from the sandbox to live keys.
- [Errors](https://docs.matambaintelligence.com/errors.md): Every error code the API returns, and how to handle it.
- [Limits](https://docs.matambaintelligence.com/limits.md): The limits on your requests, orders and allocations, and what happens when you reach one.
- [Keys and security](https://docs.matambaintelligence.com/keys-and-security.md): How API keys are issued, restricted and revoked, and what we store about your customers.
- [Versioning](https://docs.matambaintelligence.com/versioning.md): How the API is versioned, and which changes can reach you without a new version.
- [Changelog](https://docs.matambaintelligence.com/changelog.md): Changes to the API and its documentation.
- [List your accounts](https://docs.matambaintelligence.com/api-reference/accounts/list-your-accounts.md): Returns the accounts this API key can trade for. Call this first to check your setup.
- [Retrieve an account's balance](https://docs.matambaintelligence.com/api-reference/accounts/retrieve-an-accounts-balance.md): Returns the account's balance as the broker reports it. Takes no query parameters.
- [List an account's positions](https://docs.matambaintelligence.com/api-reference/accounts/list-an-accounts-positions.md): Returns the account's positions as the broker reports them. Takes no query parameters.
- [List an account's trades](https://docs.matambaintelligence.com/api-reference/accounts/list-an-accounts-trades.md): Returns buy and sell fills with a trade date from `from` to `to`, newest first. A range can include at most 1,000 records.
- [List an account's contract notes](https://docs.matambaintelligence.com/api-reference/accounts/list-an-accounts-contract-notes.md): Returns settled trades with their charges, for trades dated from `from` to `to`, newest first. A range can include at most 1,000 records.
- [List your orders](https://docs.matambaintelligence.com/api-reference/orders/list-your-orders.md): Returns your orders, newest first. If you place an order while you paginate, it appears before the first page and doesn't shift the pages that follow.
- [Place an order](https://docs.matambaintelligence.com/api-reference/orders/place-an-order.md): Stores the order, then sends it to the exchange once. If an order ends in `uncertain`, we don't send it again. Retrieve it, or wait for its event, until it resolves.
- [Estimate an order](https://docs.matambaintelligence.com/api-reference/orders/estimate-an-order.md): Returns the broker's estimate of an order's total: for a buy, what it would cost, and for a sell, what you'd receive. The estimate is indicative. Send the same body you'd use to place the order. This doesn't place or store an order, and you don't need an `Idempotency-Key`.
- [Retrieve an order](https://docs.matambaintelligence.com/api-reference/orders/retrieve-an-order.md): Returns the order, including everything the exchange has reported about it.
- [Cancel an order](https://docs.matambaintelligence.com/api-reference/orders/cancel-an-order.md): Requests a cancel of a `pending` or `partially_filled` limit order. Only limit orders can be cancelled. A `202` means the broker accepted the request, not that the order is cancelled: the order then moves to `cancelled`, or to `filled` if it fills before the cancel takes effect. Wait for the event,…
- [List your events](https://docs.matambaintelligence.com/api-reference/events/list-your-events.md): Returns every change to your orders, oldest first, whether or not your webhook endpoint accepted it. We keep events for 30 days. Store the last `next_cursor` and pass it as `cursor` next time.
- [List your applications](https://docs.matambaintelligence.com/api-reference/applications/list-your-applications.md): Returns your applications, newest first.
- [Apply for an account](https://docs.matambaintelligence.com/api-reference/applications/apply-for-an-account.md): Sends your customer's application to the broker once. We pass the identity details through without storing or logging them. If an application ends in `uncertain`, we don't send it again.
- [Retrieve an application](https://docs.matambaintelligence.com/api-reference/applications/retrieve-an-application.md): Returns the application's current state. Once it's `opened`, you can trade for the account in `account`.
- [Retrieve your wallet](https://docs.matambaintelligence.com/api-reference/wallet/retrieve-your-wallet.md): Returns your wallet. Each figure is a ledger sum, all read at the same moment. Takes no parameters.
- [List your allocations](https://docs.matambaintelligence.com/api-reference/wallet/list-your-allocations.md): Returns your allocations, newest first.
- [Allocate from your wallet](https://docs.matambaintelligence.com/api-reference/wallet/allocate-from-your-wallet.md): Moves money from your wallet to the balance of one of your accounts at the broker, and it's booked only once. We reserve the amount in the same step that checks your wallet. If an allocation ends in `uncertain`, the amount stays reserved and we don't send it again.
- [Retrieve an allocation](https://docs.matambaintelligence.com/api-reference/wallet/retrieve-an-allocation.md): Returns the allocation's current state.
- [List banks](https://docs.matambaintelligence.com/api-reference/reference/list-banks.md): Returns the broker's list of banks. Use one of these codes as an application's `bank`. Takes no parameters.
- [List states](https://docs.matambaintelligence.com/api-reference/reference/list-states.md): Returns the broker's list of states. Use these codes for an application's `state` and `state_of_origin`. Takes no parameters.
- [List a state's LGAs](https://docs.matambaintelligence.com/api-reference/reference/list-a-states-lgas.md): Returns the broker's local government areas (LGAs) for one state. Use one of these codes as an application's `lga_of_origin`. Takes no query parameters.

## OpenAPI Specs

- [openapi](/openapi.json)