App API
Brink's App API is primarily used to retrieve order data for display on front ends
Get API Information
GET
https://app-api.brink.trade/info
This endpoint returns Brink API information, such as the version of the API.
Estimate Cost of an Order
GET
https://app-api.brink.trade/estimateOrderCost
Get cost estimation for a given swap
Path Parameters
Name | Type | Description |
---|---|---|
owner* | address | address of owner |
tokenIn* | address | Address of token to be traded |
tokenOut* | address | Address of token to be received |
tokenInAmount* | bigint | number of tokens to be traded |
tokenOutAmount* | bigin | number of tokens to be received |
Get Order Details for a Single Order
GET
https://app-api.brink.trade/orders/<hash>
Using the hash of the order, retrieve order details about an order
Path Parameters
Name | Type | Description |
---|---|---|
includeHistory | Boolean | true/false (Default false) Include cost history of order |
startTime | Timestamp | Must be included if includeHistory is true. startTime for cost history Format: 2021-09-05T06:54:14.752Z All dates in UTC |
endTime | Timestamp | Must be included if includeHistory is true. endTime for cost history Format: 2021-09-05T06:54:14.752Z All dates in UTC |
Retrieve Orders
GET
https://app-api.brink.trade/orders
Endpoint to retrieve a list of orders specified by at the account level, and some other options such as order status
Path Parameters
Name | Type | Description |
---|---|---|
account | String | Account address |
signer | String | Signer address |
page | Int | Used for pagination, default 1 |
pageSize | Int | Used for pagination, default 30 |
sortDirection | String | <'asc'> or <'desc'> (default value) Sorted by creation time |
status | String | Options: 'canceled' 'filled' 'expired' 'open' 'all' (default value) |
asset | String | Filter by asset being traded String Address |
Last updated