API References

Place Order

post
https://app.bitgo-test.com/api/prime/trading/v1/accounts//orders

Places a new order. There are several types of orders available - Market, Limit, TWAP, and SteadyPace (the latter two optionally support a limit price). Orders can be funded by your account balance or on margin.

  • When an order with funding type "funded" is placed, funds will be reserved from your Go account for the amount of the order. You must have sufficient available balance in your Go account to place a funded order.
  • When an order with funding type "margin" is placed, funds will be reserved from your Margin Trade Account. You must have sufficient available margin (NOP limit) to place a margin order. See our Trade Guide for more details on each order type and funding options.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the account

Body Params
string
length ≤ 256

Custom order ID provided by the client. This must be a unique ID for each individual order and cannot be the same across multiple requests. Can be used to ensure idempotency of order requests.

string
required

Product name e.g. BTC-USD

string
required

Must be set to "market" to place a market order

string
enum
Defaults to funded

The funding type of the order.

  • Funded orders will be placed using the Go account balance.
  • Margin orders will be placed using the margin account balances. See our Trade Guide for more details on each funding type.
Allowed:
string
enum
required

The side of the order

Allowed:
string
required

The quantity of the quantityCurrency to buy or sell.

string
required

The quantity currency for the order:

  • Must be in base currency for sell orders.
  • Must be in quote currency for buy orders with fundingType: funded (default funding type).
  • Can be in base or quote currency for for buy orders with fundingType: margin. e.g. If product is BTC-USD, the base currency will be BTC and the quote currency will be USD.
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago