coins.adoc

Coins

Uses Coin Codex API

Note	Those routes will only be available if marketCap service is enabled

List symbols

GET /marketCap/symbols

Optional query parameters

Name	Type	Default	Description
includeAliases	boolean	false	If true, symbol aliases such as XRB for NANO will also be returned

Result

Result will be an array of symbols

Examples

Example for GET /marketCap/symbols

[
    "$$$",
    "020",
    "1337",
    "1CR",
    "1ST",
    ...
    "BNB",
    "BTC",
    ...
    "ETH",
    ...
    "NEO",
    ...
]

Retrieve coins

GET /marketCap/coins

Optional query parameters

Name	Type	Default	Description
includeAliases	boolean	false	If true, symbol aliases such as XRB for NANO will also be returned
names	string (comma-separated)		Comma-separated list of coin names. Any coin with a name which matches partially will be returned
symbols	string (comma-separated)		Comma-separated list of coin symbols. Any coin with a symbol which matches exactly will be returned

Result

Result will be a dictionary using symbols as keys

Examples

Example for GET /marketCap/coins/?symbols=BTC,ETH

{
    "BTC":{
        "symbol":"BTC",
        "name":"Bitcoin"
    },
    "ETH":{
        "symbol":"ETH",
        "name":"Ethereum"
    }
}