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.

Connections Resource Overview

HTTP Method

Resource

Description

GET

Details of all joined token networks

Connections Resource Details

Details 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.

Path Parameters

Name
Type
Description

version

string

Version of the API

{
    "0x2a65Aca4D5fC5B5C859090a6c34d164135398226": {
        "sum_deposits": "67",
        "channels": "3"
    },
    "0x0f114A1E9Db192502E7856309cc899952b3db1ED": {
        "sum_deposits": "31",
        "channels": "1"
    }
}

Leave 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.

Path Parameters

Name
Type
Description

version

string

Version of the API

token_address

string

Address of a token

[
    "0x41BCBC2fD72a731bcc136Cf6F7442e9C19e9f313",
    "0x5A5f458F6c1a034930E45dC9a64B99d7def06D7E",
    "0x8942c06FaA74cEBFf7d55B79F9989AdfC85C6b85"
]

Last updated

Was this helpful?