Skip to main content

ActiveRoutesRequest

Table of contents​

Properties​

Properties​

fromChainId​

• Optional fromChainId: string

Id of sending chain

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:13


fromTokenAddress​

• Optional fromTokenAddress: string

Address of token on source chain.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:17


limit​

• Optional limit: string

Number of active routes to return in one API call.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:9


offset​

• Optional offset: string

Offset for fetching active routes.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:7


routeStatus​

• Optional routeStatus: "PENDING" | "COMPLETED"

Status of the route. The route will only be marked completed if all the user txs have been completed.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:11


sort​

• Optional sort: "updatedAt" | "createdAt"

Sort param for routes.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:5


toChainId​

• Optional toChainId: string

Id of destination chain.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:15


toTokenAddress​

• Optional toTokenAddress: string

Token address on destination chain.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:19


userAddress​

• userAddress: string

Address of user starting the route.

Defined in​

socket-v2-sdk/src/client/models/ActiveRoutesRequest.ts:3