API documentation
Quotes
Transfers
Deposits
Balance
Get an order by ID
Copy
curl --request GET \
--url https://api.brl.xyz/api/v0/orders/{id}Copy
{
"order": {
"base-rate": "1.0000",
"state-updated-at": "2024-01-15T10:30:00Z",
"effective-rate": "0.9950",
"state": "created",
"target-asset": "eth-base/brlv",
"id": "660e8400-e29b-41d4-a716-446655440001",
"quote-id": "550e8400-e29b-41d4-a716-446655440000",
"source-asset": "fiat/brl",
"source-amount": "100.50",
"created-at": "2024-01-15T10:30:00Z",
"target-amount": "99.75"
}
}Orders
Get Order
Retrieves a specific order by its ID for the authenticated account
GET
/
api
/
v0
/
orders
/
{id}
Get an order by ID
Copy
curl --request GET \
--url https://api.brl.xyz/api/v0/orders/{id}Copy
{
"order": {
"base-rate": "1.0000",
"state-updated-at": "2024-01-15T10:30:00Z",
"effective-rate": "0.9950",
"state": "created",
"target-asset": "eth-base/brlv",
"id": "660e8400-e29b-41d4-a716-446655440001",
"quote-id": "550e8400-e29b-41d4-a716-446655440000",
"source-asset": "fiat/brl",
"source-amount": "100.50",
"created-at": "2024-01-15T10:30:00Z",
"target-amount": "99.75"
}
}Path Parameters
Response
Order retrieved successfully
Show child attributes
Show child attributes
Base exchange rate between assets
Example:
"1.0000"
ISO 8601 timestamp when the order state was last updated
Example:
"2024-01-15T10:30:00Z"
Effective rate including fees
Example:
"0.9950"
Current state of the order
Available options:
created, rolled-back, completed, processing Example:
"created"
The asset being converted to
Available options:
eth-base/brlv, fiat/brl, eth-base/usdt, fiat/usd, eth-base/wbrly, eth-base/usdc Example:
"eth-base/brlv"
Unique identifier for the created order
Example:
"660e8400-e29b-41d4-a716-446655440001"
Identifier of the quote this order was created from
Example:
"550e8400-e29b-41d4-a716-446655440000"
The asset being converted from
Available options:
eth-base/brlv, fiat/brl, eth-base/usdt, fiat/usd, eth-base/wbrly, eth-base/usdc Example:
"fiat/brl"
Amount of source asset to be converted
Example:
"100.50"
ISO 8601 timestamp when the order was created
Example:
"2024-01-15T10:30:00Z"
Amount of target asset to be received
Example:
"99.75"
⌘I