Get Bridge Request List

get

https://api.testnet.octet.im/2.0/bridges

This API can be called with a Global Token. By default, retrieves all bridge requests of the account, including bridges where the account is either the source or the destination.

The following optional filters are supported:

statuses (comma-separated): filter by bridge status
sourceWalletIdx: source wallet idx
destinationWalletIdx: destination wallet idx (bridges sent to an external address have no destination wallet)
sourceAddress / destinationAddress: filter by address string (exact match)
bridgeTunnelIdx: only bridges using a specific bridge tunnel

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pos

number

Defaults to 0

Position of the first record to retrieve
(default: 0)

offset

number

1 to 200

Defaults to 10

Number of records to retrieve
(default: 10, min: 1, max: 200)

order

string

enum

Defaults to desc

Sort order.
asc: Ascending
desc: Descending
(default: desc)

Allowed:

startDate

string

Start date and time of the range to retrieve (UTC+0). Retrieves records greater than or equal to this value.

endDate

string

End date and time of the range to retrieve (UTC+0). Retrieves records less than this value.

statuses

string

enum

Filter by bridge status. Pass multiple values separated by commas, without spaces. See the BridgeStatus enum for possible values (e.g. AWAITING_SOURCE_BRIDGE,SOURCE_BRIDGING,COMPLETED).

sourceWalletIdx

number

Returns only bridges whose source is this wallet.

destinationWalletIdx

number

Returns only bridges whose destination is this wallet. Bridges sent to an external address have no destination wallet and are not matched by this filter.

sourceAddress

string

Returns only bridges whose source is this address (exact string match).

destinationAddress

string

Returns only bridges whose destination is this address (exact string match).

bridgeTunnelIdx

number

Returns only bridges using this bridge tunnel.

Headers

Authorization

string

required

Defaults to Bearer

API token

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success