🇬🇧 English

Get Internal Account Order History

To using this feature you must have API key. Read at here to know how to get our API key

1. Get order history by API key

Get order history by API key

GET https://api.tronsave.io/v0/orders

Get many orders sort by created time. Default: return 10 newest orders

Query Parameters

NameTypeDescription

page

Integer

start from 0. Default:0

pageSize

Integer

default: 10

{
   data:{
     id: string, // id of order
     requester: string, // the address represent for order owner
     target: string, // the address that is received resource 
     resource_amount: number, // the amount of resource
     resource_type: string, // the amount type is "ENERGY"
     remain_amount: number, // the remain amount can matching by system
     price: number, // price unit is equal to sun
     duration: number, // rent duration, duration unit is equal to second
     allow_partial_fill: boolean, //Allow the order to be filled partially or not
     payout_amount: number, // Total payout of this order
     fulfilled_percent: number, //The percent that show filling processing. 0-100
     matched_delegates:{ //All matched delegate for this order
       delegator:string // The address that delegate resource for target address
       amount: number //The amount of resource was delegated
       txid: number // The transaction id in onchain 
     }[]
   } [],
   total:number
}

Example

Example Code

const GetOrderHistory = async (api_key) => {
    const url = "https://api.tronsave.io/v0/orders"
    const data = await fetch(url, {
        headers: {
            'apikey': api_key
        }
    })
    const response = await data.json()
    /**
     * Example response
     * @link https://docs.tronsave.io/buy-energy-on-telegram/using-api-key-to/get-internal-account-order-history 
        {
            "data": [
                {
                    "id": "651d0e5d8248d002ea08a231",
                    "requester": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
                    "target": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
                    "resource_amount": 100000,
                    "resource_type": "ENERGY",
                    "remain_amount": 100000,
                    "price": 45,
                    "duration": 259200,
                    "allow_partial_fill": false,
                    "payout_amount": 4500000,
                    "fulfilled_percent": 100,
                    "matched_delegates": [
                        {
                            "delegator": "TKVSaJQDWeKFSEXmA44pjxduGTxy888888",
                            "amount": 100000,
                            "txid": "transaction_id_1"
                        }
                    ]
                },
                {
                    "id": "651d2306e55c073f6ca0992e",
                    "requester": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
                    "target": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
                    "resource_amount": 100000,
                    "resource_type": "ENERGY",
                    "remain_amount": 0,
                    "price": 67.5,
                    "duration": 3600,
                    "allow_partial_fill": true,
                    "payout_amount": 6750000,
                    "fulfilled_percent": 100,
                    "matched_delegates": [
                        {
                            "delegator": "TKVSaJQDWeKFSEXmA44pjxduGTxy888888",
                            "amount": 100000,
                            "txid": "transaction_id_2"
                        }
                    ]
                }
            ],
            "total": 2
        }
     */
    return response
}

2. Get one order details by api key

Get one order details by api key

GET https://api.tronsave.io/v0/orders/:id

{
    id: string, // id of order
    requester: string, // the address represent for order owner
    target: string, // the address that is received resource 
    resource_amount: number, // the amount of resource
    resource_type: string, // the amount type is "ENERGY"
    remain_amount: number, // the remain amount can matching by system
    price: number, // price unit is equal to sun
    duration: number, // rent duration, duration unit is equal to second
    allow_partial_fill: boolean, //Allow the order to be filled partially or not
    payout_amount: number, // Total payout of this order
    fulfilled_percent: number, //The percent that show filling processing. 0-100
    matched_delegates:{ //All matched delegate for this order
       delegator:string // The address that delegate resource for target address
       amount: number //The amount of resource was delegated
       txid: number // The transaction id in onchain 
     }[]
}

Example 

{
  "apikey": <YOUR_API_KEY>
}

Example Code

const GetOneOrderDetails = async (api_key, order_id) => {
    const url = `https://api.tronsave.io/v0/orders/${order_id}`
    const data = await fetch(url, {
        headers: {
            'apikey': api_key
        }
    })
    const response = await data.json()
    /**
     * Example response 
     * @link https://docs.tronsave.io/buy-energy-on-telegram/using-api-key-to/get-internal-account-order-history
        {
            "id": "651d2306e55c073f6ca0992e",
            "requester": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
            "target": "TKVSaJQDWeKFSEXmA44pjxduGTxy999999",
            "resource_amount": 100000,
            "resource_type": "ENERGY",
            "remain_amount": 0,
            "price": 67.5,
            "duration": 3600,
            "allow_partial_fill": true,
            "payout_amount": 6750000,
            "fulfilled_percent": 100,
            "matched_delegates": [
                        {
                            "delegator": "TKVSaJQDWeKFSEXmA44pjxduGTxy888888",
                            "amount": 100000,
                            "txid": "transaction_id_1"
                        }
                    ]
        }
     */
    return response
}
PreviousGet Internal Account InfoNextGet Order Book

Last updated