Get Order Details

Retrieve detailed information and the current status of a specific order using its orderId.

Retrieve detailed information and the current status of a specific order using its orderId. The response includes the order parameters, fulfillment progress, and every on-chain delegate that has matched the order.

Endpoint

GET https://api.tronsave.io/v2/order/:id

The :id path segment is the orderId returned when the order was created.

Rate limit: 15 requests per 1 second.

Headers

Name
Type
Description

apikey*

String

TronSave API key that represents the internal account. See Authentication to get your API key.

* Required.

Path parameters

Name
Type
Description

id*

String

The orderId of the order to retrieve.

Request body

This endpoint takes no request body — pass the apikey header and the order id in the path.

Response

A successful response returns error: false and the order details in data.

Field
Type
Description

data.id

String

ID of the order.

data.requester

String

The address that represents the order owner.

data.receiver

String

The address that receives the resource.

data.resourceAmount

Number

The amount of resource.

data.resourceType

String

The resource type, either ENERGY or BANDWIDTH.

data.remainAmount

Number

The remaining amount that can still be matched by the system.

data.price

Number

Price, in SUN.

data.durationSec

Number

Rent duration, in seconds.

data.orderType

String

Type of order, either NORMAL or EXTEND.

data.allowPartialFill

Boolean

Whether the order may be filled partially.

data.payoutAmount

Number

Total payout of this order.

data.fulfilledPercent

Number

The fill progress as a percentage, 0–100.

data.delegates

Array

All matched delegates for this order.

data.delegates[].delegator

String

The address that delegates the resource to the target address.

data.delegates[].amount

Number

The amount of resource that was delegated.

data.delegates[].txid

String

The on-chain transaction ID.

200: OK

Success response example

Errors

This endpoint authenticates with the apikey header. Missing or invalid keys return 401.

401 Unauthorized — missing API key

401 Unauthorized — invalid API key

400 Bad Request - Invalid orderId

404 Not Found — wrong route/path

Request examples

Next steps

Last updated