Messages

Search Message

get

Use the following parameters to search messages.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Query parameters

accountinteger[] | nullableOptional

Returns messages signed by the provided account.

Default: null

created_afterstring · date-time | nullableOptional

Returns objects created after the entered date.

Default: nullExample: 2020-09-12T14:15:22Z

created_beforestring · date-time | nullableOptional

Returns objects created before the entered date.

Default: nullExample: 2020-12-13T16:17:28Z

idinteger | nullableOptional

Returns the object corresponding to the entered ID

Default: null

message_typestring · enum | nullableOptional

Filters the list of results by message type.

Default: nullPossible values:

orderstring · enum | nullableOptional

Orders the list of results

Default: nullExample: descPossible values:

order_bystring | nullableOptional

criteria to order by

Default: nullExample: name

pageinteger | nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger | nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Default: 20Example: 40

Responses

200

Message search results

application/json

400

Invalid search parameters

application/json

get

HTTPcURLJavaScriptPython

GET /messages HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "account_id": 1,
        "address": "bc1q2kqvs8wx455lw2f69j5z34emypjup07fp0fcrp",
        "created_by": 5,
        "created_on": "2025-05-30T17:39:39.645Z",
        "data": "Welcome to the web3",
        "id": 1,
        "last_request": 3,
        "message_type": "EIP-191",
        "notes": [
          {
            "content": "some information about this transaction",
            "title": "a note title"
          }
        ],
        "signature": "0x",
        "status": "PENDING_APPROVAL",
        "type": "MESSAGE_SIGNATURE"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}

Get a message by id

get

This method returns the message that matches the entered ID.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

message_idintegerRequired

The message's ID.

Responses

200

Message object

application/json

404

Message not found

application/json

get

HTTPcURLJavaScriptPython

GET /messages/{message_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "account_id": 1,
  "address": "bc1q2kqvs8wx455lw2f69j5z34emypjup07fp0fcrp",
  "created_by": 5,
  "created_on": "2025-05-30T17:39:39.645Z",
  "data": "Welcome to the web3",
  "id": 1,
  "last_request": 3,
  "message_type": "EIP-191",
  "notes": [
    {
      "content": "some information about this transaction",
      "title": "a note title"
    }
  ],
  "signature": "0x",
  "status": "PENDING_APPROVAL",
  "type": "MESSAGE_SIGNATURE"
}