Skip to main content
POST

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Body

application/json

Send numbers as JSON numbers, not quoted strings. We reject unknown fields and any field that appears twice, even with different letter case.

account
string
required

An account code. Case-insensitive on input, and returned in uppercase.

Pattern: ^[A-Za-z0-9]{1,64}$
symbol
string
required

The exchange's symbol, treated as uppercase. The exchange decides whether the symbol exists.

Pattern: ^[A-Za-z0-9.-]{1,20}$
side
enum<string>
required
Available options:
buy,
sell
quantity
integer<int64>
required

The number of shares, as a whole number.

Required range: 1 <= x <= 100000000
type
enum<string>
required
Available options:
limit,
market
time_in_force
enum<string>
required
Available options:
day,
gtc,
ioc,
fok
price_kobo
integer<int64>

The limit price in kobo, so ₦475.00 is 47500. Required for a limit order. Omit it for a market order.

Required range: 1 <= x <= 1000000000

Response

The estimate.

object
string
required
Allowed value: "order_estimate"
account
string
required
symbol
string
required
side
enum<string>
required
Available options:
buy,
sell
quantity
integer<int64>
required
type
enum<string>
required
Available options:
limit,
market
time_in_force
enum<string>
required
Available options:
day,
gtc,
ioc,
fok
price_kobo
integer<int64> | null
required

The limit price in kobo. Null for a market order.

estimated_total_kobo
integer<int64>
required

The exchange's estimate of the order's total. This is indicative, not a quote.