Prices

Estimate price

Estimate the volume-weighted price to buy or sell a quantity of an asset. The estimate is nonbinding and does not create an order or reserve funds.

post/trading/prices

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopestrading.prices:read
TypeScript
https://skmtc.dev/uphold/apis/trading-api/docs/trading/prices/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.

basestring required

The base asset, the one bought or sold.

quotestring required

The quote asset, the one the price is expressed in.

side'buy' | 'sell' required

Whether the base asset is bought or sold.

quantitystring required

The quantity of the base asset to estimate the price of.

Price estimated.

pricestring required

The estimated volume-weighted execution price, in the quote asset per one unit of the base asset.

snapshotAtstring date-time required

The time of the order book snapshot the price was calculated from. It is not the time of the request or of the calculation.

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