Get the balance of a hex-encoded Ed25519 address.

GET 
http://127.0.0.1:14265/api/v1/addresses/ed25519/:address

Get the balance of a hex-encoded Ed25519 address.

Request

Path Parameters

address stringrequired
hex-encoded Ed25519 address
Example: efdc112efe262b304bcf379b26c31bad029f616ee3ec4aa6345a366e4c9e43a3

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

addressType integerrequired

The type of the address. Value 0 denotes a Ed25519 address.

address stringrequired

The hex-encoded Ed25519 address.

balance integerrequired

The computed balance for the address.

dustAllowed booleanrequired

Tells whether the address can receive dust or not.

ledgerIndex integerrequired

The current ledger index for which the request was made.

Example (from schema)

{
  "data": {
    "addressType": 0,
    "address": "string",
    "balance": 0,
    "dustAllowed": true,
    "ledgerIndex": 0
  }
}

default

{
  "data": {
    "addressType": 0,
    "address": "efdc112efe262b304bcf379b26c31bad029f616ee3ec4aa6345a366e4c9e43a3",
    "balance": 1338263,
    "dustAllowed": true,
    "ledgerIndex": 946704
  }
}

400

Unsuccessful operation: indicates that the provided data is 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"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

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"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

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

• CURL

curl -L -X GET 'http://127.0.0.1:14265/api/v1/addresses/ed25519/:address' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:14265

Parameters

address — pathrequired

ResponseClear

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