Address API

Address API#

Address Staking Info / History#

GET /v2/address/staking_info/(address)#
Query Parameters:

  • height – (optional) retrieve data at a specific block height. Mutually exclusive with time.

  • time – (optional) retrieve data at a specific time. Accepts a number as unix epoch, or a string in ISO 8601 format. Mutually exclusive with height.

Response JSON Object:

  • height (int) – block height of the data.

  • timestamp (int) – block timestamp.

  • amount (str) – bonded amount of the address in microcredits.

  • validator (str) – validator the address is / was bonded to.

Get the staking info of an address, now or at specific time in the past. Returns null if the address is not bonded.

Example request:

GET /v2/address/staking_info/aleo1sdjqhlcm9qltpu74ek0vxewt52zsdmn6swmpjn6m0tp9xf57dvpq740r8j HTTP/1.1
Host: api.aleoscan.io

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "height": 1230000,
    "timestamp": 1712200000,
    "amount": 10000000000,
    "validator": "aleo1n6c5ugxk6tp09vkrjegcpcprssdfcf7283agcdtt8gu9qex2c5xs9c28ay"
}
Status Codes:

Address Delegated Credits / History#

GET /v2/address/delegated/(address)#
Query Parameters:

  • height – (optional) retrieve data at a specific block height. Mutually exclusive with time.

  • time – (optional) retrieve data at a specific time. Accepts a number as unix epoch, or a string in ISO 8601 format. Mutually exclusive with height.

Response JSON Object:

  • height (int) – block height of the data.

  • timestamp (int) – block timestamp.

  • amount (str) – delegated amount of the address in microcredits.

Get the amount of tokens delegated to the address, now or at specific time in the past. Returns null if no tokens are delegated to the address.

Example request:

GET /v2/address/delegated/aleo1sdjqhlcm9qltpu74ek0vxewt52zsdmn6swmpjn6m0tp9xf57dvpq740r8j HTTP/1.1
Host: api.aleoscan.io

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "height": 1230000,
    "timestamp": 1712200000,
    "amount": 10000000000000
}
Status Codes:

Address Program ID#

GET /v2/address/program_id/(address)#

Get the program ID of an address, if it is a program address. Returns null if the address is not a program address.

Example request:

GET /v2/address/program_id/aleo12x4rzm2j56e9uknpy0dcglt32vfk9ujx9e0pl8x7sy77jjyx4cps5sp8hm HTTP/1.1
Host: api.aleoscan.io

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

"vlink_quest_v1.aleo"
Status Codes:
Contents