Accounts

get
List Accounts
https://api.helium.io/v1/accounts
Retrieve the current set of known accounts.The result is paged. A cursor field is present if more results are available.Note: The cursor for accounts is valid for a limited time. If you receive a 400 http response code for a cursor based request, you will need to start fetching accounts from the beginning of the list.
Request
Response
Request
Query Parameters
cursor
optional
string
Cursor for the page of accounts to fetch
Response
200: OK
Accounts successfully retrieved.
{
    "data": [
        {
            "sec_nonce": 0,
            "sec_balance": 0,
            "nonce": 2,
            "dc_nonce": 0,
            "dc_balance": 0,
            "block": 435239,
            "balance": 0,
            "address": "13etjTqyGLK7WQh8pp9VJy5ejh5MXmwFee2eAi3TfAA5kS1jEJb"
        },
        {
            "sec_nonce": 0,
            "sec_balance": 0,
            "nonce": 1,
            "dc_nonce": 0,
            "dc_balance": 0,
            "block": 435239,
            "balance": 0,
            "address": "14Vshtwv9RMY5GuTe1sgLDJmmF2f46EW3etEJzjDjhKJSEprtHh"
        },
        {
            "sec_nonce": 0,
            "sec_balance": 0,
            "nonce": 0,
            "dc_nonce": 0,
            "dc_balance": 0,
            "block": 435239,
            "balance": 404040732,
            "address": "14PaJeSfNp5Q3MtDw5yEsJwb2kHJqbcjjLe9aycjroqNFnL4EyS"
        },
        {
            "sec_nonce": 0,
            "sec_balance": 0,
            "nonce": 0,
            "dc_nonce": 0,
            "dc_balance": 0,
            "block": 435239,
            "balance": 1025990703,
            "address": "13rUthiDQUeY9HfwoZFpkqtsbtaubzRyerCsSu1qdDXuVZGL45k"
        },
        {
            "sec_nonce": 0,
            "sec_balance": 0,
            "nonce": 0,
            "dc_nonce": 0,
            "dc_balance": 0,
            "block": 435239,
            "balance": 179087000000,
            "address": "14Xg1SqiJDsmM2YvchR4UacevcuxjfyrjdyNEpRMmfBU7vrZba9"
        }
    ],
    "cursor": "eyJoZWlnaHQiOjQzNTIzOSwiYmVmb3JlX2Jsb2NrIjo0MTM3MDIsImJlZm9yZV9hZGRyZXNzIjoiMTRpdndTNnRBQXVzRFo0QXVucTZXZ2dUc285cEZFbXZ2eXM5S1NXYUJDRENMd1UyMURkIn0"
}
get
List Richest Accounts
https://api.helium.io/v1/accounts/rich
Returns up to 1000 of the accounts sorted by highest token balance.
Request
Response
Request
Query Parameters
limit
optional
string
Number of accounts to return. Default 1000, max 1000
Response
200: OK
Result for /v1/accounts/rich?limit=2
{
    "data": [
        {
            "address": "1398hLeHESZHE5jVtaLAV5fdg2vrUeZEs2B92t7TzeQTtugr8dL",
            "balance": 616416488712965,
            "block": 489719,
            "dc_balance": 0,
            "dc_nonce": 0,
            "nonce": 3,
            "sec_balance": 351543978600,
            "sec_nonce": 0
        },
        {
            "address": "14GWyFj9FjLHzoN3aX7Tq7PL6fEg4dfWPY8CrK8b9S5ZrcKDz6S",
            "balance": 292033864604925,
            "block": 489719,
            "dc_balance": 0,
            "dc_nonce": 0,
            "nonce": 0,
            "sec_balance": 166398670100,
            "sec_nonce": 0
        }
    ]
}
get
Account for Address
https://api.helium.io/v1/accounts/:address
Retrieve a specific account record.The account details for a record include additional speculative nonces that indicate what the expected nonce for the account is for a specific balance. Any transactions affecting the given balance type should use an adjusted speculative nonce for that balance type.For example, when constructing a payment transaction, get the speculative_nonce field for the source account and use speculative_nonce + 1 for the new transaction nonce.Currently only the speculative_nonce is supported. It indicates the expected nonce for the account
Request
Response
Request
Path Parameters
address
required
string
Account B58 address to fetch details for
Response
200: OK
{
    "data": {
        "address": "1122ZQigQfeeyfSmH2i4KM4XMQHouBqK4LsTp33ppP3W2Knqh8gY",
        "balance": 0,
        "block": 311833,
        "dc_balance": 100000000000000,
        "dc_nonce": 0,
        "nonce": 0,
        "sec_balance": 0,
        "sec_nonce": 0,
        "speculative_nonce": 0
    }
}
get
Hotspots for Account
https://api.helium.io/v1/accounts/:address/hotspots
Fetches hotspots owned by a given account address.The list of returned hotspots is paged. If a cursor field is present more results are available.Note: The cursor for accounts is valid for a limited time. If you receive a 400 http response code for a cursor based request, you will need to start fetching accounts from the beginning of the list.
Request
Response
Request
Path Parameters
address
required
string
Account B58 address to fetch hotspots for
Query Parameters
cursor
optional
string
Cursor for the next page of hotspots to fetch
Response
200: OK
The hotspot list for an account
{
    "data": [
        {
            "lng": -81.70707772367822,
            "lat": 41.480133219396784,
            "status": {
                "online": "online",
                "height": 435166,
                "gps": "good_fix"
            },
            "score_update_height": 435153,
            "score": 0.9222412109375,
            "owner": "13GCcF7oGb6waFBzYDMmydmXx4vNDUZGX4LE3QUh8eSBG53s5bx",
            "nonce": 1,
            "name": "sneaky-violet-penguin",
            "location": "8c2ab38f19a43ff",
            "geocode": {
                "short_street": "W 32nd St",
                "short_state": "OH",
                "short_country": "US",
                "short_city": "Cleveland",
                "long_street": "West 32nd Street",
                "long_state": "Ohio",
                "long_country": "United States",
                "long_city": "Cleveland",
                "city_id": "Y2xldmVsYW5kb2hpb3VuaXRlZCBzdGF0ZXM"
            },
            "block_added": 96087,
            "block": 435241,
            "address": "1182nyT3oXZPMztMSww4mzaaQXGXd5T7JwDfEth6obSCwwxxfsB"
        }
    ]
}
get
Pending Transactions for Account
https://api.helium.io/v1/accounts/:address/pending_transactions
Fetches the outstanding transactions for the given account. See Pending Transactions for details.The list of returned pending transactions is paged. If a cursor field is present more results are available.
Request
Response
Request
Path Parameters
address
required
string
Account B58 address to fetch pending transactions for
Query Parameters
cursor
optional
string
Cursor for the next page of transactions to fetch
Response
200: OK
A single pending transaction for a given account
{
    "data": [
        {
            "created_at": "2020-04-30T18:13:17.411141Z",
            "failed_reason": "",
            "hash": "IUXgVfnYPlv_Br3Rhng6bKTaLb_AzX9DC3E9NGJhAKs",
            "status": "pending",
            "txn": {
                "fee": 0,
                "nonce": 6,
                "payer": "13C8mAv3M3SUQ1ZgREHsGxabcsHtDCkmkJLp9sGimqfWT4GRf9W",
                "payments": [
                    {
                        "amount": 2,
                        "payee": "13C8mAv3M3SUQ1ZgREHsGxabcsHtDCkmkJLp9sGimqfWT4GRf9W"
                    }
                ],
                "signature": "TcB6zhMf6_ImaMyuTbWRd33W-hlzCwxxZtyIeJRQwUTvHN00V1U4Jn7ooyNHjFAoBgvxBDN2VmQ5Fez0OQoICA"
            },
            "type": "payment_v2",
            "updated_at": "2020-04-30T18:47:19.960477Z"
        }
    ]
}
get
Rewards for an Account
https://api.helium.io/v1/accounts/:address/rewards
Returns reward entries by block and gateway for a given account in a timeframe. Timestamps are given in ISO 8601 format. The block that contains the max_time timestamp is excluded from the result.
Request
Response
Request
Path Parameters
addresss
required
string
Account B58 address to fetch rewards for
Query Parameters
cursor
optional
string
Cursor for next page of rewards to fetch
max_time
required
string
Last timestamp to include rewards for
min_time
required
string
First timestamp to include rewards for
Response
200: OK
Request for a account rewards between max_time=2020-08-29&min_time=2020-08-27. Note the result cursor to fetch more data
{
    "cursor": "eyJlbmRfYmxvY2siOjQ2OTUzMCwiYmxvY2siOjQ3MDgwMCwiYW5jaG9yX2Jsb2NrIjo0NzA4MDB9",
    "data": [
        {
            "account": "12xUoMKwf12ABjNx4VCvYcNkX79gW1kzz2JnBLxkFbjswRczRvM",
            "amount": 11772690,
            "block": 470864,
            "gateway": "113kQU96zqePySTahB7PEde9ZpoWK76DYK1f57wyhjhXCBoAu88",
            "hash": "MQZ9fdiy5wz4utLwp8ePSGUPyNOEdx_0nh32f98b58w",
            "timestamp": "2020-08-28T02:58:47.000000Z"
        },
        {
            "account": "12xUoMKwf12ABjNx4VCvYcNkX79gW1kzz2JnBLxkFbjswRczRvM",
            "amount": 7975287,
            "block": 470828,
            "gateway": "113kQU96zqePySTahB7PEde9ZpoWK76DYK1f57wyhjhXCBoAu88",
            "hash": "Tl-pp7ysTy2BIB15xNOGo3570MKPT9lrxZzQmv2dJHk",
            "timestamp": "2020-08-28T02:16:52.000000Z"
        }
    ]
}
get
Reward Total for an Account
https://api.helium.io/v1/accounts/:address/rewards/sum
Returns the total rewards for a given account in a given timeframe. Timestamps are given in ISO 8601 format. The block that contains the max_time timestamp is excluded from the result.
Request
Response
Request
Path Parameters
address
required
string
Account B58 address to fetch rewards for
Query Parameters
min_time
required
string
First timestamp to include rewards for
max_time
required
string
Last timestmap to include rewards for
Response
200: OK
Returns the total rewards over a given time range
{
    "data": {
        "max_time": "2020-08-29T00:00:00Z",
        "min_time": "2020-08-27T00:00:00Z",
        "sum": "176714898"
    }
}