Bandwidth Refill Quote

GET

api

bandwidth

auto-refill

quote

Bandwidth Refill Quote

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

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/bandwidth/auto-refill/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bandwidth/auto-refill/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/auto-refill/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/auto-refill/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

{
  "add_volume": 123,
  "duration": "<string>",
  "estimated_cost_per_refill_trx": "<string>"
}

Returns what one refill of add_volume bandwidth for duration costs your account: the price a rule with these settings pays per refill, fixed fee included. Nothing is created or charged. Requires the view scope. The price depends on how you call it. Called with an API key, it is the price of a rule created with that API key; from the website, the price of a rule created on the website. It is the price at the moment of the request, and it does not include activating an address that does not exist on-chain yet — the first refill adds that.

Query parameters

number

required

Bandwidth per refill. From 350 to 100,000, the same range as when creating a rule.

string

default:"1h"

Rental duration of each refill: 1h or 1d.

Response

number

The volume you asked about

string

The duration you asked about — 1h or 1d

string

Full price of one refill for your account, fixed fee included

Example

curl "https://api.tronrental.com/v1/bandwidth/auto-refill/quote?add_volume=5000&duration=1d" \
  -H "X-API-Key: your_api_key"

import requests

resp = requests.get(
    "https://api.tronrental.com/v1/bandwidth/auto-refill/quote",
    headers={"X-API-Key": "your_api_key"},
    params={"add_volume": 5000, "duration": "1d"},
)
print(resp.json())

const resp = await fetch(
  "https://api.tronrental.com/v1/bandwidth/auto-refill/quote?add_volume=5000&duration=1d",
  { headers: { "X-API-Key": "your_api_key" } },
);
console.log(await resp.json());

Response

{
  "add_volume": 5000,
  "duration": "1d",
  "estimated_cost_per_refill_trx": "0.500000"
}

Errors

Status	Code	When
`403`	`FORBIDDEN`	The API key lacks the `view` scope
`422`	—	`add_volume` is missing or outside 350 – 100,000, or `duration` is not `1h` or `1d`
`503`	`TEMPORARILY_UNAVAILABLE`	The price could not be read right now — retry after the `Retry-After` seconds

{
  "detail": {
    "error": {
      "code": "TEMPORARILY_UNAVAILABLE",
      "message": "Please retry shortly"
    }
  }
}

A validation error comes in the framework’s format, with detail as an array:

{
  "detail": [
    {
      "type": "literal_error",
      "loc": ["query", "duration"],
      "msg": "Input should be '1h' or '1d'",
      "input": "2h",
      "ctx": {"expected": "'1h' or '1d'"}
    }
  ]
}

Bandwidth Refill Quote

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

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/bandwidth/auto-refill/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bandwidth/auto-refill/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/auto-refill/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/auto-refill/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

{
  "add_volume": 123,
  "duration": "<string>",
  "estimated_cost_per_refill_trx": "<string>"
}

Core API

Bandwidth Rentals

Auto Refill

Orders

Invoices

Smart Mode

Transfer Packages

Account

Webhooks

Bandwidth Refill Quote