blockchain

Get messages

Get messages by specified filters.

get/api/v3/messages

Request

  • Base URL: https://toncenter.com (the document declares no server; this is the origin it was published from)
  • URL: https://toncenter.com/api/v3/messages
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

msg_hashstring[]

Message hash. Acceptable in hex, base64 and base64url forms.

body_hashstring

Hash of message body.

sourcestring

The source account address. Can be sent in hex, base64 or base64url form. Use value null to get external messages.

destinationstring

The destination account address. Can be sent in hex, base64 or base64url form. Use value null to get log messages.

opcodestring

Opcode of message in hex or signed 32-bit decimal form.

start_utimeinteger

Query messages with created_at >= start_utime.

end_utimeinteger

Query messages with created_at >= start_utime.

start_ltinteger

Query messages with created_lt >= start_lt.

end_ltinteger

Query messages with created_lt <= end_lt.

direction'in' | 'out'

Direction of message.

exclude_externalsboolean

Exclude external messages.

only_externalsboolean

Return only external messages.

limitinteger

Limit number of queried rows. Use with offset to batch read.

offsetinteger

Skip first N rows. Use with limit to batch read.

sort'asc' | 'desc'

Sort messages by effective LT: created_lt for internal/external-out messages and the receiving transaction LT for external-in messages.

Response

OK

address_bookAddressBook
metadataMetadata

Example response

{
  "messages": [
    {
      "created_at": "0",
      "created_lt": "0",
      "fwd_fee": "0",
      "ihr_fee": "0",
      "import_fee": "0",
      "value": "0"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.