Get order details

Retrieve detailed information about a specific order by its ID.

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

{orderId}

TypeScript

const response: Promise<FireblocksResponse<OrderDetails>> = fireblocks.tradingBeta.getOrder(tradingBetaApiGetOrderRequest);

CompletableFuture<ApiResponse<OrderDetails>> response = fireblocks.tradingBeta().getOrder(orderId);

response = fireblocks.trading_beta.get_order(order_id);

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

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/trading/orders/{orderId}', 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/{orderId}",
  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/{orderId}"

	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/{orderId}")

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

{
  "id": "order_9f4e2d8b1c6a5e73",
  "via": {
    "type": "PROVIDER_ACCOUNT",
    "providerId": "bridge-provider-001",
    "accountId": "acc_9f4e2d8b1c6a5e73"
  },
  "status": "PROCESSING",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:30.000Z",
  "receipt": {
    "type": "BLOCKCHAIN",
    "txHash": "0x1234567890abcdef",
    "amount": "0.02458"
  },
  "generalFees": [
    {
      "feeType": "ORDER",
      "assetId": "USDC",
      "amountType": "FIXED",
      "amount": "5.00"
    }
  ],
  "executionSteps": [
    {
      "type": "EXECUTE",
      "status": "PROCESSING",
      "fee": {
        "feeType": "NETWORK",
        "assetId": "ETH",
        "amountType": "FIXED",
        "amount": "0.01"
      },
      "txId": "tx_abc123def456"
    }
  ],
  "executionResponseDetails": {
    "type": "MARKET",
    "side": "BUY",
    "baseAmount": "1000.00",
    "baseAssetId": "USDC",
    "quoteAssetId": "BTC"
  },
  "settlement": {
    "type": "PREFUNDED",
    "destinationAccount": {
      "type": "VAULT_ACCOUNT",
      "accountId": "vault_acc_9f4e2d8b1c6a5e73"
    }
  },
  "createdBy": "user_123abc456def789",
  "customerInternalReferenceId": "order_ref_2024_001",
  "note": "Monthly investment order"
}

{
  "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"
}

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

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

Path Parameters

orderId

string

required

The ID of the order to fetch.

Minimum string length: 1

Response

Order response

string

required

via

object

required

Option 1
Option 2

Show child attributes

Example:

{
  "type": "PROVIDER_ACCOUNT",
  "providerId": "bridge-provider-001",
  "accountId": "acc_9f4e2d8b1c6a5e73"
}

status

enum<string>

required

Available options:

CREATED,

AWAITING_PAYMENT,

AWAITING_INFORMATION,

PENDING_USER_ACTION,

PROCESSING,

CANCELED,

COMPLETED,

FAILED

Example:

"PROCESSING"

createdAt

string<date-time>

required

executionSteps

object[]

required

Show child attributes

executionResponseDetails

object

required

Option 1
Option 2

Show child attributes

Example:

{
  "side": "BUY",
  "baseAmount": "1000.00",
  "baseAssetId": "USDC",
  "baseAssetRail": "BLOCKCHAIN",
  "quoteAssetId": "BTC",
  "quoteAssetRail": "BLOCKCHAIN",
  "type": "MARKET"
}

settlement

object

required

Settlement configuration for the order

Option 1
Option 2

Show child attributes

Example:

{
  "type": "PREFUNDED",
  "destinationAccount": {
    "type": "VAULT_ACCOUNT",
    "accountId": "vault_acc_9f4e2d8b1c6a5e73"
  }
}

createdBy

string

required

The ID of the user who created the order

updatedAt

string<date-time>

receipt

object

Option 1
Option 2

Show child attributes

Example:

{
  "type": "BLOCKCHAIN",
  "txHash": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b",
  "amount": "250.75"
}

generalFees

object[]

Option 1
Option 2

Show child attributes

Example:

{ "amountType": "FIXED", "amount": "0.01" }

participantsIdentification

object

KYC/AML participant identification

Show child attributes

Example:

{
  "originator": {
    "externalReferenceId": "user_123456",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "FirstParty",
    "fullName": { "firstName": "John", "lastName": "Smith" },
    "dateOfBirth": "1985-03-15",
    "email": "john.smith@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Main Street",
      "buildingNumber": "123",
      "postalCode": "10001",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  },
  "beneficiary": {
    "externalReferenceId": "user_789012",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "ThirdParty",
    "fullName": {
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "dateOfBirth": "1990-07-22",
    "email": "alice.johnson@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Broadway",
      "buildingNumber": "456",
      "postalCode": "10002",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  }
}

paymentInstructions

object[]

Payment instructions for the order, the client can use one of these to pay the order.

Show child attributes

Example:

{
  "type": "BLOCKCHAIN",
  "address": {
    "blockchainAddress": "0x1234567890123456789012345678901234567890",
    "tag": "1234567890"
  }
}

customerInternalReferenceId

string

Internal reference ID for the customer

note

string

Optional note for the Order

Maximum string length: 512

expiresAt

string<date-time>

failure

object

Show child attributes

Get order requirement details for an orderFetch order requirement details for an order that is in `AWAITING_INFORMATION` status. The response includes `requirementId` and `dueBy` metadata, a `requiredData` JSON Schema (Draft-7) describing the shape of the `data` object expected on `POST /trading/orders/{orderId}/requirement/data`, and `requiredFiles` descriptors for any files the provider requires (uploaded via `POST /trading/orders/{orderId}/requirement/file`). 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](https://developers.fireblocks.com/reference/api-error-codes).

⌘I

TypeScript

const response: Promise<FireblocksResponse<OrderDetails>> = fireblocks.tradingBeta.getOrder(tradingBetaApiGetOrderRequest);

CompletableFuture<ApiResponse<OrderDetails>> response = fireblocks.tradingBeta().getOrder(orderId);

response = fireblocks.trading_beta.get_order(order_id);

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

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/trading/orders/{orderId}', 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/{orderId}",
  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/{orderId}"

	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/{orderId}")

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

{
  "id": "order_9f4e2d8b1c6a5e73",
  "via": {
    "type": "PROVIDER_ACCOUNT",
    "providerId": "bridge-provider-001",
    "accountId": "acc_9f4e2d8b1c6a5e73"
  },
  "status": "PROCESSING",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:30.000Z",
  "receipt": {
    "type": "BLOCKCHAIN",
    "txHash": "0x1234567890abcdef",
    "amount": "0.02458"
  },
  "generalFees": [
    {
      "feeType": "ORDER",
      "assetId": "USDC",
      "amountType": "FIXED",
      "amount": "5.00"
    }
  ],
  "executionSteps": [
    {
      "type": "EXECUTE",
      "status": "PROCESSING",
      "fee": {
        "feeType": "NETWORK",
        "assetId": "ETH",
        "amountType": "FIXED",
        "amount": "0.01"
      },
      "txId": "tx_abc123def456"
    }
  ],
  "executionResponseDetails": {
    "type": "MARKET",
    "side": "BUY",
    "baseAmount": "1000.00",
    "baseAssetId": "USDC",
    "quoteAssetId": "BTC"
  },
  "settlement": {
    "type": "PREFUNDED",
    "destinationAccount": {
      "type": "VAULT_ACCOUNT",
      "accountId": "vault_acc_9f4e2d8b1c6a5e73"
    }
  },
  "createdBy": "user_123abc456def789",
  "customerInternalReferenceId": "order_ref_2024_001",
  "note": "Monthly investment order"
}

{
  "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"
}

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

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

Introduction

Errors & Statuses

Data Objects

API Endpoints

Get order details

Path Parameters

Response