Quote Bandwidth

GET

api

bandwidth

quote

Quote Bandwidth

curl --request GET \
  --url https://api.example.com/api/v1/bandwidth/quote

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bandwidth/quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/v1/bandwidth/quote"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/bandwidth/quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "volume": 123,
  "duration": "<string>",
  "price_sun": "<string>",
  "rental_trx": "<string>",
  "fixed_fee_trx": "<string>",
  "total_trx": "<string>",
  "personal_price": true
}

Returns the exact amount a bandwidth order of this volume and duration will be charged — rental and fixed fee together, at your rate. The quote is calculated by the same code that charges the order, so while the price is unchanged the purchase costs exactly total_trx. This endpoint is public — authentication is optional. Send your API key to be quoted your own rate and fixed fee; without it you get the public price.

Show total_trx to your user and pass it as max_price_trx to Buy Bandwidth. If the price changes between the quote and the purchase, the purchase is refused with 409 PRICE_CHANGED and nothing is charged — quote again and retry.

Query parameters

integer

required

Bandwidth units to price. Between 1 and 100,000.

string

default:"1h"

Rental period: 1h, 1d, or a whole number of minutes from 5m to 59m — the same values as in Buy Bandwidth.

Headers

string

Optional. With a valid key the response reflects your negotiated rate and your fixed fee. An absent, invalid or revoked key is not an error — you get the public price with personal_price: false.

Response

number

Bandwidth units the quote was calculated for

string

Rental period the quote was calculated for

string

Rate in SUN per 1 bandwidth unit, rounded to 0.01 for display. Minute terms carry a discount, so their rate is fractional, and the amounts below are calculated from the exact rate — take total_trx rather than multiplying this rounded value yourself.

string

Rental cost for this volume and duration, without the fixed fee

string

Fixed fee, charged once per order regardless of volume and duration. Reflects your own fee if a custom fee, discount or waiver applies to your account.

string

What you will be charged: rental_trx + fixed_fee_trx. Pass it as max_price_trx to Buy Bandwidth.

boolean

true when your negotiated rate was applied, false when the quote is at the public price. Check it: a forgotten X-API-Key header otherwise looks like a normal response, and you would quote your customers the public price while being charged your own.

Example

curl "https://api.tronrental.com/v1/bandwidth/quote?volume=1000&duration=5m" \
  -H "X-API-Key: your_api_key"

import requests

resp = requests.get(
    "https://api.tronrental.com/v1/bandwidth/quote",
    params={"volume": 1000, "duration": "5m"},
    headers={"X-API-Key": "your_api_key"},
)
print(resp.json()["total_trx"])

const resp = await fetch(
  "https://api.tronrental.com/v1/bandwidth/quote?volume=1000&duration=5m",
  { headers: { "X-API-Key": "your_api_key" } }
);
const quote = await resp.json();
console.log(quote.total_trx);

Values below are an example, with price_sun_1h of 400 and short_max_discount_pct of 5. Current rates and the discount are in Get Bandwidth Prices.

Response

{
  "volume": 1000,
  "duration": "5m",
  "price_sun": "380.00",
  "rental_trx": "0.380000",
  "fixed_fee_trx": "0.2",
  "total_trx": "0.580000",
  "personal_price": false
}

What the quote does not include

The quote — and max_price_trx — covers the bandwidth order only. If the target address is not activated on-chain yet, Buy Bandwidth activates it and charges the activation on top (activation_cost_trx in its response). That charge is not part of total_trx and is not checked against max_price_trx.

Acting on another account: `GET /v1/bandwidth/quote/me`

/bandwidth/quote prices for the owner of the API key. If your key acts on another account with the X-Account-Id header, the purchase is charged at that account’s rate and fee — the quote may differ from the charge, and a max_price_trx taken from it may be refused with 409 PRICE_CHANGED. Use GET /v1/bandwidth/quote/me in that case. It takes the same query parameters and returns the same response, but authentication is required, and the account is resolved exactly as for the purchase, X-Account-Id included. It needs the view scope, which every key always has.

cURL

curl "https://api.tronrental.com/v1/bandwidth/quote/me?volume=1000&duration=5m" \
  -H "X-API-Key: your_api_key" \
  -H "X-Account-Id: 12345"

Errors

Code	Meaning
`400 INVALID_VOLUME`	Volume outside 1–100,000
`400 INVALID_DURATION`	Duration other than `1h`, `1d` or `5m` … `59m`
`401 INVALID_TOKEN`	`/quote/me` only: API key missing, unknown or disabled
`403 FORBIDDEN`	`/quote/me` only: your key has no active access to the account in `X-Account-Id`

On /bandwidth/quote an invalid or revoked X-API-Key is not an error: the quote is returned at the public price with personal_price: false.

Quote Bandwidth

curl --request GET \
  --url https://api.example.com/api/v1/bandwidth/quote

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bandwidth/quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/v1/bandwidth/quote"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/bandwidth/quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "volume": 123,
  "duration": "<string>",
  "price_sun": "<string>",
  "rental_trx": "<string>",
  "fixed_fee_trx": "<string>",
  "total_trx": "<string>",
  "personal_price": true
}

Core API

Bandwidth Rentals

Auto Refill

Orders

Invoices

Smart Mode

Transfer Packages

Account

Webhooks

Quote Bandwidth

Quote Bandwidth

Query parameters

Headers

Response

Example

What the quote does not include

Acting on another account: `GET /v1/bandwidth/quote/me`

Errors

​Quote Bandwidth

​Query parameters

​Headers

​Response

​Example

​What the quote does not include

​Acting on another account: GET /v1/bandwidth/quote/me

​Errors

Quote Bandwidth

Query parameters

Headers

Response

Example

What the quote does not include

Acting on another account: `GET /v1/bandwidth/quote/me`

Errors