Get Order Book

Retrieve the current Energy or Bandwidth order book with available offers and prices, authenticated with a TronSave API key.

Retrieve the current Energy and Bandwidth order book with the available offers and their prices. Use it to inspect resource pricing and depth before placing an order.

GET https://api.tronsave.io/v2/order-book

Rate limit: 15 requests per 1 second.

Headers

Name	Type	Description
apikey*	String	TronSave API key tied to your internal account. See Authentication.

* Required.

Query parameters

Name	Type	Description
address	String	Resource receiver address.
minDelegateAmount	Number	The minimum amount of Energy delegated from one provider.
durationSec	Number	Order duration in seconds.
resourceType	String	"ENERGY" or "BANDWIDTH". Default: ENERGY.

Response

Each entry in data describes one price level: price is the price in SUN and availableResourceAmount is the resource amount available at that price.

200: OK

{
    "error": false,
    "message": "Success",
    "data": [
        {
            "price": 602,
            "availableResourceAmount": 1179
        },
        {
            "price": 650,
            "availableResourceAmount": 2409
        },
        {
            "price": 700,
            "availableResourceAmount": 5395
        },
        {
            "price": 701,
            "availableResourceAmount": 6613
        }
    ]
}

401: Missing API key

{
    "error": true,
    "message": "TSAS:106 API_KEY_REQUIRED",
    "data": null
}

401: Invalid API key

{
    "error": true,
    "message": "TSAS:107 INVALID_API_KEY",
    "data": null
}

400: Validation error

{
    "statusCode": 400,
    "code": "FST_ERR_VALIDATION",
    "error": "Bad Request",
    "message": "querystring must have required property 'address'"
}

Example

Query parameters:

Key	Value
address	TFwUFWr3QV376677Z8VWXxGUAMFSrq11111
resourceType	BANDWIDTH
minDelegateAmount	1000
durationSec	86400

Request examples

cURL

curl -X GET "https://api.tronsave.io/v2/order-book?address=YOUR_TRON_ADDRESS" \
  -H "apikey: YOUR_API_KEY"

JavaScript

const TRONSAVE_API_URL = "https://api.tronsave.io";

const getOrderBook = async (apiKey, receiverAddress) => {
  const url = `${TRONSAVE_API_URL}/v2/order-book?address=${receiverAddress}`;
  const res = await fetch(url, {
    method: "GET",
    headers: {
      apikey: apiKey,
    },
  });
  return res.json();
};

getOrderBook("YOUR_API_KEY", "YOUR_TRON_ADDRESS").then(console.log);

Python

import requests

TRONSAVE_API_URL = "https://api.tronsave.io"

def get_order_book(api_key: str, receiver_address: str) -> dict:
    url = f"{TRONSAVE_API_URL}/v2/order-book"
    headers = {"apikey": api_key}
    params = {"address": receiver_address}

    response = requests.get(url, headers=headers, params=params)
    return response.json()

print(get_order_book("YOUR_API_KEY", "YOUR_TRON_ADDRESS"))

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetOrderBook {
    public static void main(String[] args) throws Exception {
        String apiKey = "YOUR_API_KEY";
        String receiverAddress = "YOUR_TRON_ADDRESS";
        String url = "https://api.tronsave.io/v2/order-book?address=" + receiverAddress;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("apikey", apiKey)
                .GET()
                .build();

        HttpResponse<String> response =
                client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	apiKey := "YOUR_API_KEY"
	receiverAddress := "YOUR_TRON_ADDRESS"
	url := "https://api.tronsave.io/v2/order-book?address=" + receiverAddress

	req, err := http.NewRequest(http.MethodGet, url, nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", apiKey)

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Rust

use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api_key = "YOUR_API_KEY";
    let receiver_address = "YOUR_TRON_ADDRESS";
    let url = format!(
        "https://api.tronsave.io/v2/order-book?address={}",
        receiver_address
    );

    let client = reqwest::blocking::Client::new();
    let resp: Value = client
        .get(&url)
        .header("apikey", api_key)
        .send()?
        .json()?;

    println!("{:#?}", resp);
    Ok(())
}

Next steps

• Estimate TRX for a resource amount and rental duration.

• Buy Energy (Create Order) once you have picked a price level.

• Learn the difference between Energy and Bandwidth.