Orders

Create order

Create an order to buy or sell an asset.

post/trading/orders

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopestrading.orders:create
TypeScript
https://skmtc.dev/uphold/apis/trading-api/docs/trading/orders/post.ts
A function with typed inputs. Its response is checked against the schema.

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

clientOrderIdstring required

A unique key you choose for the order. Replaying it returns the existing order.

side'buy' | 'sell' required

Whether the base asset is bought or sold.

type'market' | 'limit' required

The type of the order.

quantitystring required

The quantity of the base asset to trade.

pricestring

The limit price, in the quote asset per one unit of the base asset. Required on a limit order, and not allowed on a market order.

timeInForce'fok' required

How long the order stays active. Only fok is supported for now.

Order already existed.

No recorded changes to this operation across all 1 revision of this API.