get https://api.upbit.com/v1/orders/closed
Request Order List by Closed Order
Request Parameters
Request orders using Closed Order(done, cancel).
- Query Order List by ID
v1/orders/uuids
for more information.- Query Open Orders
v1/orders/open
for more information.
Field Name | Description | Type |
---|---|---|
market | Market ID | String |
state | Order Statusdone : All completed orderscancel : Order cancel- If a market order is not retrieved: A market buy order can have both a cancel and done order status after execution.- Remaining order quantity after a market order is executed will be returned and the order will be canceled. In most cases, a minimal amount that does not divide evenly up to 8 decimal places will become the order quantity. - If the order is executed exactly without any remaining quantity, the order state will be done . | String |
states | List of Order Status, default: ['done', 'cancel'] ***The default values are for both done and cancel .* 'state' and 'states' cannot be used at the same time. Please specify only one of them. | Array[String] |
start_time | Request start time (based on order creation time) - start_time and end_time must be in ISO-8601 format with Time Zone included. (ex. 2024-03-13T00:00+09:00)- If both start_time and end_time are not defined, orders up to 7 days before the current time will be retrieved - If only start_time is defined, orders up to 7 days after start_time are retrieved. - If only end_time is defined, orders within the past 7 days from end_time will be retrieved. - If both start_time and end_time are defined, orders within a maximum range of 7 days will be retrieved. - *Even if orders are within the specified time frame, they will not be retrieved if they exceed the limit count, try in smaller batches. | String |
end_time | Request End Time (based on Order Creation Time) | String |
limit | Number of requests, default: 100, max: 1,000 - The maximum number of orders that can be viewed is 1,000, and if the number of orders within the time range exceeds 1,000, the time range must be searched separately. | Number |
order_by | Sorting Method - asc : ascending- desc : descending (default) | String |
*By default, if no parameters are specified, the response will include the most recent 100 closed orders within the last 7 days.
Response
Field Name | Description | Type |
---|---|---|
uuid | Unique Order ID | String |
side | Kinds of orders | String |
ord_type | Method of orders - limit : Limit Order- price : Market Price Order (Bid)- market : Market Price Order (Ask)- best : Best Order | String |
price | Currency price at the moment of order | NumberString |
state | State of order | String |
market | Market ID | String |
created_at | The time when the order was made | DateString |
volume | The amount of order entered by the users | NumberString |
remaining_volume | The amount remaining after the order | NumberString |
reserved_fee | The cost reserved for the commission | NumberString |
remaining_fee | Remaining commission fee | NumberString |
paid_fee | Used commission fee | NumberString |
locked | Fee being used for transactions | NumberString |
executed_volume | Traded Volume | NumberString |
executed_funds | Executed fund | NumberString |
trades_count | The number of Transactions in the order | Integer |
time_in_force | IOC, FOK setting - ioc : Immediate or Cancel- fok : Fill or Kill | String |
*Null value Fields are excluded from the response. (e.g., in the case of an order without IOC or FOK settings, the time_in_force field will not be included in the response.)