Skip to main content

get_aliases

Returns a page of registered aliases, selected by offset and count, ordered by their registration sequence in the blockchain.

Request​

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "get_aliases",
  "params": {
    "offset": 0,
    "count": 3
  }
}

Request parameters​

  • offset - unsigned integer; zero-based index of the first alias to return, counted over all registered aliases in registration order.
  • count - unsigned integer; maximum number of aliases to return starting from offset. Fewer entries are returned when the end of the alias list is reached.

Unlike get_all_alias_details, which takes no parameters and returns every alias registered in the blockchain in a single response, get_aliases returns only the requested slice, which makes it the right call for paging through the alias list on a node that has many registrations.

Response​

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "aliases": [
      {
        "alias": "nirmata",
        "address": "NiRqzHVJfBJUj1WBUvHTPzYAJ4cKA6PQb2ZR33ZmS4Zp7DDcUxUE29nAkMtLPfCPXwPUgvYRZZ9NM2gN4uRRP1e12wTGSCMzn",
        "comment": "Official project alias",
        "tracking_key": ""
      },
      {
        "alias": "exchange",
        "address": "NiRCn8fKmvenQRNdoFFsDinWMfucfC5H9Abb71HjUFbPcEgaCk1fdjqSe4ZDskYgLQtRUFYDH1AqUAWDHjmu84hSG394mceDgb",
        "comment": "",
        "tracking_key": ""
      },
      {
        "alias": "donations",
        "address": "NiRCn8fKmvenQRNdoFFsDinWMfucfC5H9Abb71HjUFbPcEgaCk1fdjqSe4ZDskYgLQtRUFYDH1AqUAWDHjmu84hSG394mceDgb",
        "comment": "Send tips here",
        "tracking_key": "8f1cdd2e6ba2fa0a8f7fd2a1cbe0d3b4a5c6e7f8091a2b3c4d5e6f708192a3b4"
      }
    ],
    "status": "OK"
  }
}

Response information​

  • aliases - array of objects; the requested slice of registered aliases. Empty when offset is past the end of the alias list.
    • alias - string; the alias name.
    • address - string; the Nirmata address the alias resolves to.
    • comment - string; user-defined comment set by the alias owner. Empty when no comment was provided.
    • tracking_key - string; hex-encoded secret view key of the wallet, published voluntarily by the alias owner. Empty when the owner did not publish one.
  • status - "OK" on success. While the daemon is still synchronizing with the network it returns a JSON-RPC error with code CORE_BUSY and the message "Core is busy." instead of a normal result (see Daemon RPC API).