Get orders

Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range.

Note:These endpoints are currently in beta and might be subject to changes.

If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

For detailed information about error codes and troubleshooting, please refer to our API Error Codes documentation.

GET

trading

orders

TypeScript

const response: Promise<FireblocksResponse<GetOrdersResponse>> = fireblocks.tradingBeta.getOrders(tradingBetaApiGetOrdersRequest);

CompletableFuture<ApiResponse<GetOrdersResponse>> response = fireblocks.tradingBeta().getOrders(pageSize, pageCursor, order, accountId, providerId, statuses, startTime, endTime, assetConversionType);

response = fireblocks.trading_beta.get_orders(page_size, page_cursor, order, account_id, provider_id, statuses, start_time, end_time, asset_conversion_type);

curl --request GET \
  --url https://api.fireblocks.io/v1/trading/orders

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/trading/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "ord_5f8e2d9c1a7b4e36",
      "via": {
        "type": "PROVIDER_ACCOUNT",
        "providerId": "prov_8c3f1a4b2d6e9f7c",
        "accountId": "acc_5e9a2d1c4b7f3e8a"
      },
      "baseAmount": "1000.00",
      "quoteAmount": "0.02458",
      "baseAssetId": "USD",
      "quoteAssetId": "BTC",
      "status": "COMPLETED",
      "destination": {
        "type": "VAULT_ACCOUNT",
        "accountId": "vault_acc_7b2e5d8f1c4a9e3b"
      },
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 1,
  "next": "cursor_next_page_token"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Query Parameters

pageSize

integer

required

pageSize for pagination.

Required range: 1 <= x <= 100

pageCursor

string

Minimum string length: 1

order

enum<string>

default:DESC

ASC / DESC ordering (default DESC)

Available options:

ASC,

DESC

accountId

string[]

Filter by accountId.

Minimum string length: 1

providerId

string[]

Filter by providerId.

Minimum string length: 1

statuses

enum<string>[]

Filter by order status.

Available options:

CREATED,

AWAITING_PAYMENT,

AWAITING_INFORMATION,

PENDING_USER_ACTION,

PROCESSING,

CANCELED,

COMPLETED,

FAILED

startTime

integer

Required range: x >= 0

endTime

integer

Required range: x >= 0

assetConversionType

enum<string>

Filter by asset conversion type.

Available options:

DIGITAL_ONLY,

FIAT

Response

Orders response

data

object[]

required

Show child attributes

total

integer

required

Total number of orders matching the query.

string

A cursor for the next page of results, if available.

Create an orderCreate an order to buy or sell an asset. If no source is given, an external source will be use. Note: These endpoints are currently in beta and might be subject to changes. If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes).

⌘I

TypeScript

const response: Promise<FireblocksResponse<GetOrdersResponse>> = fireblocks.tradingBeta.getOrders(tradingBetaApiGetOrdersRequest);

CompletableFuture<ApiResponse<GetOrdersResponse>> response = fireblocks.tradingBeta().getOrders(pageSize, pageCursor, order, accountId, providerId, statuses, startTime, endTime, assetConversionType);

response = fireblocks.trading_beta.get_orders(page_size, page_cursor, order, account_id, provider_id, statuses, start_time, end_time, asset_conversion_type);

curl --request GET \
  --url https://api.fireblocks.io/v1/trading/orders

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/trading/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "ord_5f8e2d9c1a7b4e36",
      "via": {
        "type": "PROVIDER_ACCOUNT",
        "providerId": "prov_8c3f1a4b2d6e9f7c",
        "accountId": "acc_5e9a2d1c4b7f3e8a"
      },
      "baseAmount": "1000.00",
      "quoteAmount": "0.02458",
      "baseAssetId": "USD",
      "quoteAssetId": "BTC",
      "status": "COMPLETED",
      "destination": {
        "type": "VAULT_ACCOUNT",
        "accountId": "vault_acc_7b2e5d8f1c4a9e3b"
      },
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 1,
  "next": "cursor_next_page_token"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Get orders

Query Parameters

Response