Skip to main content

get_alias_by_address

Returns alias details by alias address.

Request​

{
    "jsonrpc": "2.0",
    "id": 0,
    "method": "get_alias_by_address",
    "params": "NiRDNaMeZjwCjnHuU5gUNyrP1pM3U5vckbakzzV6dEHyDYeCpW8XGLBFTshcaY8LkG9RQn7FsQx8w2JeJzJwPwuDm2NfixPAXf"
}

Request parameters​

Unlike most other daemon methods, this one does not take a named parameter object: params is the address string itself.

  • params - string; the public address to look the alias up for. If the value cannot be parsed as an address, the call still returns a result but with status set to FAILED.

Response​

{
    "id": 0,
    "jsonrpc": "2.0",
    "result": {
        "alias_info": {
            "address": "NiRDNaMeZjwCjnHuU5gUNyrP1pM3U5vckbakzzV6dEHyDYeCpW8XGLBFTshcaY8LkG9RQn7FsQx8w2JeJzJwPwuDm2NfixPAXf",
            "alias": "nirmata_example",
            "comment": "Coolest username",
            "tracking_key": ""
        },
        "status": "OK"
    }
}

Response information​

  • alias_info - object; details of the alias registered for the requested address. Left empty when status is not OK. Fields:
    • address - string; public address associated with requested alias.
    • alias - string; alias associated with the provided address.
    • comment - string; an arbitrary comment set by the owner. Can be empty.
    • tracking_key - string; private view key for public address. Can be empty.
  • status - string; call result. OK if an alias was found for the address, NOT FOUND if the address is valid but has no alias registered, or FAILED if the address could not be parsed or the alias details could not be retrieved.