Connections
The connections endpoints allow you to automatically connect to a token network as well as leave a token network by closing and settling all open channels.
HTTP Method | Resource | Description |
GET | Details of all joined token networks | |
DELETE | Leave a token network |
Currently all API calls are blocking. In case of long running API calls like joining or leaving a token network, if any concurrent API calls are made they will be queued.
getDetails of All Joined Token Networks
get
http://localhost:5001/api/v1/connections
Each key in the JSON response object is a token address for which you have open channels.
Request
Response
Request
Path Parameters
version
required
string
Version of the API
Response
200: OK
Successful query
The value for the token address key is an object containing:
- "sum_deposits", a string of the sum of deposits in all currently open channels
- "channels", a string of all channels currently open for the specific token
{"0x2a65Aca4D5fC5B5C859090a6c34d164135398226": {"sum_deposits": "67","channels": "3"},"0x0f114A1E9Db192502E7856309cc899952b3db1ED": {"sum_deposits": "31","channels": "1"}}
500: Internal Server Error
Internal Raiden node error
deleteLeave a Token Network
delete
http://localhost:5001/api/v1/connections/0x2a65...8226
The request might take some time and will only return once all blockchain calls for closing and settling a channel have been completed.
The response is a list with addresses of all closed channels.
Request
Response
Request
Path Parameters
version
required
string
Version of the API
token_address
required
string
Address of a token
Response
200: OK
Successfully leaving a token network
["0x41BCBC2fD72a731bcc136Cf6F7442e9C19e9f313","0x5A5f458F6c1a034930E45dC9a64B99d7def06D7E","0x8942c06FaA74cEBFf7d55B79F9989AdfC85C6b85"]
404: Not Found
The token address is not a valid EIP55-encoded Ethereum address
500: Internal Server Error
Internal Raiden node error
Last updated 7 months ago