Skip to content

The networks your organisation can use

GET
/v1/networks
curl --request GET \
--url https://api.sotirea.com/v1/networks \
--header 'Authorization: Bearer <token>'

Every network of your key’s environment that Sotirea runs: its CAIP-2 id, its coin, how long a movement takes to be final there, the tokens Sotirea recognises on it, and whether payments are open there now. A network or token that is not available right now is left out; what you hold there still shows in your balances, marked paused, and a payment there is refused with network_unavailable or asset_unavailable.

Done.

Media typeapplication/json
object
data
required
Array<object>
object
coin
required

The network’s own coin, the one its fees are paid in from your gas pool.

object
decimals
required
integer
symbol
required
string
environment
required

Test or live, the same as your key’s.

string
finality
required

The same in words: seconds, or about so many minutes.

string
finality_seconds
required

How long a deposit or payment usually takes to be final and counted, in seconds.

integer
id
required

The network’s CAIP-2 id, like eip155:1: what vaults, balances and payments name it by.

string
name
required
string
payments_open
required

Whether payments can be sent on this network now. Deposits are received either way.

boolean
tokens
required

The tokens Sotirea recognises here. Any other token that arrives is credited too, with recognised false.

Array<object>
object
contract
required

The token’s contract, in lower case: what a payment names as its asset.

string
decimals
required
Any of:
integer
symbol
required
string
meta
object
request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string
success
required

Example

{
"success": true
}

Refused or failed, in words a person can act on.

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string
meta
object
request_id

Quote it when asking about a request.

string
success
required

Example

{
"success": false
}