Returns the top richest addresses.

GET 
http://127.0.0.1:8000/api/explorer/v2/ledger/richest-addresses

Returns the top richest addresses at the ledger state specified by the provided index.

Request

Query Parameters

ledgerIndex integer
The milestone index to be used to determine the ledger state. Defaults to the application's current ledger index.
Example: 200000
top number
The number of richest addresses to return.
Example: 100

Responses

200

Successful operation.

application/json

Schema

Schema

top object[]required
The top wealthiest addresses.
Array [
address objectrequired
oneOf
Ed25519Address
type integerrequired
Set to value 0 to denote an Ed25519 Address.
pubKeyHash stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
balance stringrequired
The total balance within this range.
]

Example (from schema)

{
  "top": [
    {
      "balance": "string"
    }
  ]
}

default

{
  "top": [
    {
      "address": [
        {
          "type": 0,
          "pubKeyHash": "0x3845105b59429361a75b3203a6e24e16d19540aad6bd1936449b62f1c4bbe5da"
        }
      ],
      "balance": "2779164783277761"
    },
    {
      "address": [
        {
          "type": 0,
          "pubKeyHash": "0xd0d361341fa3bb2f6855039a82ee9ea470c3336eaf34d22767fdfa901ba63e31"
        }
      ],
      "balance": "7398600000"
    }
  ],
  "ledgerIndex": 1005429
}

400

Unsuccessful operation: indicates that the provided parameters are invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:8000/api/explorer/v2/ledger/richest-addresses' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:8000

Parameters

ledgerIndex — query

top — query

ResponseClear

Click the Send API Request button above and see the response here!