Get Order

Retrieves the current state of an order.

• Historical data prior to May 16, 2022 is unavailable.

GET /profiles/{profile_id}/orders/{id}

Try it

Get Order

cURL

curl --request GET \
  --url https://api.paxos.com/v2/profiles/{profile_id}/orders/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "ref_id": "my-order-1",
  "status": "SUBMITTED",
  "market": "ETHUSD",
  "side": "BUY",
  "type": "LIMIT",
  "price": "190.23",
  "base_amount": "2.35781498",
  "quote_amount": "",
  "metadata": {
    "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339"
  },
  "amount_filled": "0.00000000",
  "volume_weighted_average_price": "0.00000000",
  "time_in_force": "GTC",
  "is_triggered": false
}

OAuth Scope

exchange:read_order

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

profile_id · string · required

The profile ID associated with the order.

id · string · required

The UUID of the Order.

Response

200 - application/json

A successful response.

id · string

The UUID of the order.

profile_id · string

The profile ID the order is associated with.

ref_id · string

The idempotence ID for order creation. Can be reused if the order has been closed for more than 24 hours.

status · enum<string>

Available options: PENDING_SUBMISSION, SUBMITTED, OPEN, FILLED, CANCELLED, REJECTED

side · enum<string>

Trade side.

Available options: BUY, SELL

market · enum<string>

Available options: ETHEUR, ETHSGD, ETHUSD, BTCEUR, BTCSGD, BTCUSD, PAXGUSD, BCHUSD, LTCUSD, USDPUSD, LINKUSD, MATICUSD, AAVEUSD, UNIUSD

type · enum<string>

Trade type.

Available options: LIMIT, MARKET, POST_ONLY_LIMIT, STOP_MARKET, STOP_LIMIT

base_amount · string

The base amount or purchase amount for a market sell order.

price · string

The quote price.

quote_amount · string

The quote amount of purchase for a market buy order.

metadata · object

Client-specified metadata.

Show child attributes

metadata. {key} · string

created_at · string<date-time>

The time at which the order was created.

modified_at · string<date-time>

The time at which the order was last modified.

amount_filled · string

The amount that was filled.

volume_weighted_average_price · string

The volume-weighted average price.

time_in_force · enum<string>

How long an order will remain active before it expires.

• Immediate-or-Cancel (IOC): Cancel if not executed immediately, partial fills allowed.
• Good-Til-Canceled (GTC): Order can be canceled at any point until executed.
• Good-Til-Time (GTT): Expires if not executed by a specified time. GTT must be greater than 10 seconds after the order is placed, otherwise the order will be rejected.
• Fill-or-Kill (FOK): Fill entire order only or cancel entire order, does not allow for partial filling.

Time in Force validity for Order Types

Order type	Immediate or Cancel (IOC)	Good Til Canceled (GTC)	Good Til Time (GTT)	Fill or Kill (FOK)
Market Order	Default	-	-	-
Limit Order	Valid	Default	Valid	Valid
Post Only Limit	Valid	Default	Valid	Valid
Stop Market	-	Default	Valid	-
Stop Limit	-	Default	Valid	-

Available options: GTC, FOK, IOC, GTT

expiration_date · string<date-time>

The date the order will expire if not completed when specified time in force is GTT.

identity_id · string

The end user that requests the trade. This field must be used in conjunction with identity_account_id, otherwise the order is rejected. Depending on your integration type, identity_id and identity_account_id may be required.

identity_account_id · string

The account under which this order is placed. The provided identity must be allowed to trade on behalf of this account. This field must be used in conjunction with identity_id, otherwise the order is rejected. Depending on your integration type, identity_account_id and identity_id may be required.

stop_price · string

recipient_profile_id · string

The profileId that will receive settled currency (base for buy orders, quote for sell orders).

is_triggered · boolean

Returns true when a stop order has been triggered.