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>'

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>"
}

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.