/address

Scopes

Here you can find all the scopes available in this particular namespace.

WS
info

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["info"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
Response
200: OK
Successful result.
[
"received address info",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"info": AddressInfo
}
}
]

WS
assets

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["assets"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
asset_codes
optional
list
Default: []
Response
200: OK
Successful result.
[
"received address assets",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"assets": Dict[str, AddressAsset]
}
}
]

WS
portfolio

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["portfolio"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
portfolio_fields
optional
enum
PortfolioFields: all, assets. Default: assets
Response
200: OK
Successful result.
[
"received address portfolio",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"portfolio": Portfolio
}
}
]

WS
transactions

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["transactions"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
transactions_limit
optional
int
Default: 50
transactions_offset
optional
int
Default: 0
transactions_search_query
optional
str
Default: -
Response
200: OK
Successful result.
[
"received address transactions",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"transactions": List[Transaction]
}
}
]

WS
charts

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["charts"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
charts_type
optional
str
Default: d
charts_max_assets
optional
int
Default: 0
charts_min_percentage
optional
int
Default: 100
Response
200: OK
Successful result.
[
"received address charts",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"charts": Dict[str, List[Tuple[int, float]]]
}
}
]

WS
deposits

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["deposits"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address deposits",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"deposits": List[Deposit]
}
}
]

WS
loans

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["loans"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address loans",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"loans": List[Loan]
}
}
]

WS
locked-assets

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["locked-assets"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address locked-assets",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"locked-assets": List[LockedAsset]
}
}
]

WS
staked-assets

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["staked-assets"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address staked-assets",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"staked-assets": List[StakedAsset]
}
}
]

WS
bsc-assets

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["bsc-assets"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address bsc-assets",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"bsc-assets": Dict[str, AddressBSCAsset]
}
}
]

WS
polygon-assets

wss://api-v4.zerion.io/address
Example request [ "get", { "scope": ["polygon-assets"], "payload": { "body parameter": "value" } } ]
Request
Response
Request
Body Parameters
address
optional
str
Default: -
addresses
optional
list
Default: []
currency
optional
enum
PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd
Response
200: OK
Successful result.
[
"received address polygon-assets",
{
"meta": {
"status": "ok",
"request parameter1": "value1",
"request parameter2": "value2"
},
"payload": {
"polygon-assets": Dict[str, AddressPolygonAsset]
}
}
]