Currencies

List currencies

get

Returns the list of currencies supported on the Ledger Vault.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Responses

200

Currency list

application/json

get

HTTPcURLJavaScriptPython

GET /currencies HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

200

Currency list

{
  "currencies": [
    {
      "family": "bitcoin",
      "name": "bitcoin",
      "num_confirmation_needed": 1,
      "type": "CRYPTO",
      "units": [
        {
          "code": "tBTC",
          "magnitude": 8
        }
      ]
    }
  ]
}

Get currency by name

get

Returns the requested currency.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

currency_namestringRequired

The currency name.

Responses

200

Currency object

application/json

404

Currency not found

application/json

get

HTTPcURLJavaScriptPython

GET /currencies/{currency_name} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "family": "bitcoin",
  "name": "bitcoin",
  "num_confirmation_needed": 1,
  "type": "CRYPTO",
  "units": [
    {
      "code": "tBTC",
      "magnitude": 8
    }
  ]
}

Check that the currency name and address pair is valid

get

Returns a boolean indicating the validity of the address.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

addressstringRequired

Address to validate.

currency_namestringRequired

The currency name.

Responses

200

Address validation result

application/json

404

Currency not found

application/json

get

HTTPcURLJavaScriptPython

GET /currencies/{currency_name}/{address} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "is_valid": true
}