Get outbound message queue size

Returns the current size of the outbound message queue for each shard. A growing queue indicates network congestion. If the queue is large, transactions may take longer to process. Monitor this to detect network issues.

GET /api/v2/getOutMsgQueueSize

Get outbound message queue size

cURL

curl --request GET \
  --url https://toncenter.com/api/v2/getOutMsgQueueSize \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://toncenter.com/api/v2/getOutMsgQueueSize"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://toncenter.com/api/v2/getOutMsgQueueSize', 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://toncenter.com/api/v2/getOutMsgQueueSize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://toncenter.com/api/v2/getOutMsgQueueSize"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://toncenter.com/api/v2/getOutMsgQueueSize")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://toncenter.com/api/v2/getOutMsgQueueSize")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

200

{
  "ok": true,
  "result": {
    "@type": "blocks.outMsgQueueSizes",
    "shards": [
      {
        "@type": "blocks.outMsgQueueSize",
        "id": {
          "@type": "ton.blockIdExt",
          "workchain": 123,
          "shard": "<string>",
          "seqno": 123,
          "root_hash": "<string>",
          "file_hash": "<string>"
        },
        "size": 123
      }
    ],
    "ext_msg_queue_size_limit": 123
  },
  "@extra": "<string>"
}

{
  "ok": false,
  "code": 401,
  "error": "API key does not exist"
}

{
  "ok": false,
  "code": 403,
  "error": "Network not allowed"
}

{
  "ok": false,
  "code": 429,
  "error": "Ratelimit exceeded"
}

{
  "ok": false,
  "code": 504,
  "error": "LITE_SERVER_NETWORK timeout"
}

Authorizations

APIKeyHeaderAPIKeyQuery

X-API-Key · string · header · required

API key header of the form X-API-Key: <token>, where <token> is the API key. Requests without a key are limited to 1 RPS. Refer to the authentication guide for details.

Response

200

application/json

Outgoing message queue sizes for all active shards. A growing queue indicates network congestion and may cause transaction delays.

ok · boolean · default: true · required

Returns true if the request succeeded; otherwise false. See the error field for details.

result · object · required

Show child attributes

@extra · string

Optional request ID that can be passed in the request and received back in the response. Useful for matching async responses.