Find Ticket

GET

smart-transfers

TypeScript

const response: Promise<FireblocksResponse<SmartTransferTicketFilteredResponse>> = fireblocks.smartTransfer.searchTickets(smartTransferApiSearchTicketsRequest);

CompletableFuture<ApiResponse<SmartTransferTicketFilteredResponse>> response = fireblocks.smartTransfer().searchTickets(q, statuses, networkId, createdByMe, expiresAfter, expiresBefore, type, externalRefId, after, limit, sortBy, order);

response = fireblocks.smart_transfer.search_tickets(q, statuses, network_id, created_by_me, expires_after, expires_before, type, external_ref_id, after, limit, sort_by, order);

curl --request GET \
  --url https://api.fireblocks.io/v1/smart-transfers

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/smart-transfers', 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/smart-transfers",
  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/smart-transfers"

	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/smart-transfers")

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

{
  "message": "Success",
  "after": "118320d2-761f-46c7-96cf-65e71a370b36",
  "data": [
    {
      "id": "118320d2-761f-46c7-96cf-65e71a370b36",
      "type": "ASYNC",
      "status": "DRAFT",
      "createdByNetworkId": "3eaa94c5-128b-4835-bb08-3111bb6564c7",
      "createdByNetworkIdName": "Network id name",
      "createdAt": "2023-03-01T11:23:00Z",
      "updatedAt": "2023-03-01T11:23:00Z",
      "direction": "EXCHANGE",
      "dvpExecutionStatus": "STARTED",
      "orderCreatedByNetworkId": "3eaa94c5-128b-4835-bb08-3111bb6564c7",
      "terms": [
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "status": "CREATED"
        },
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "fromNetworkIdName": "Source network profile 1",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "toNetworkIdName": "Destination network profile 1",
          "status": "FUNDING",
          "connectionId": "14817440-d5c8-4dbd-a754-ad415683610c",
          "fbTxId": "79075e8c-1fd9-4c97-9575-3bd9229e5c0d",
          "createdAt": "2023-03-01T11:23:00.000Z",
          "updatedAt": "2023-03-01T11:23:00.000Z"
        },
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "fromNetworkIdName": "Source network profile 2",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "toNetworkIdName": "Destination network profile 2",
          "status": "FUNDED",
          "connectionId": "14817440-d5c8-4dbd-a754-ad415683610c",
          "fbTxId": "79075e8c-1fd9-4c97-9575-3bd9229e5c0d",
          "txHash": "0xb5c8bd9430b6cc87a0e2fe110ece6bf527fa4f170a4bc8cd032f768fc5219838",
          "createdAt": "2023-03-01T11:23:00.000Z",
          "updatedAt": "2023-03-01T11:23:00.000Z"
        }
      ],
      "expiresIn": "13",
      "expiresAt": "2023-03-01T11:23:00Z",
      "submittedAt": "2023-03-01T11:23:00Z",
      "expiredAt": "2023-03-01T11:23:00Z",
      "canceledAt": "2023-03-01T11:23:00Z",
      "fulfilledAt": "2023-03-01T11:23:00Z",
      "externalRefId": "2631ffb9d8fe47c6b0825b5be28297da",
      "note": "Random note",
      "canceledByNetworkIdName": "Network id name",
      "canceledByMe": true,
      "createdByMe": true
    }
  ]
}

{
  "message": "You do not have permission to execute this action",
  "code": 3002
}

Query Parameters

string

Search string - counterparty name or asset or ticketId. Optional

Minimum string length: 1

statuses

enum<string>[]

Ticket statuses for Smart Transfer tickets. Optional

Available options:

DRAFT,

PENDING_APPROVAL,

OPEN,

IN_SETTLEMENT,

FULFILLED,

EXPIRED,

CANCELED

networkId

string

NetworkId that is used in the ticket . Optional

createdByMe

boolean

Filter created tickets by created by self or by others. Optional

expiresAfter

string<date-time>

Lower bound of search range. Optional

expiresBefore

string<date-time>

Upper bound of search range. Optional

type

enum<string>

Type of transfer. ASYNC executes transfers as they are funded, DVP executes all terms (legs) as one dvp transfer

Available options:

ASYNC,

DVP

externalRefId

string

External ref. ID that workspace can use to identify ticket outside of Fireblocks system.

Required string length: 1 - 64

after

string

ID of the record after which to fetch $limit records

limit

number

Number of records to fetch. By default, it is 100

Required range: x >= 1

sortBy

enum<string>

default:createdAt

Sort by field

Available options:

createdAt,

updatedAt,

submittedAt

Example:

"createdAt"

order

enum<string>

default:DESC

ASC / DESC ordering (default DESC)

Available options:

ASC,

DESC

Example:

"DESC"

Response

Smart Transfer tickets were returned successfully

message

string | null

required

Result message

Example:

"Success"

after

string

required

Unique id of next filtered result

Example:

"118320d2-761f-46c7-96cf-65e71a370b36"

data

(object | null)[]

required

Result that match given query criteria

Data object with result data

Show child attributes

Create TicketCreates a new Smart Transfer ticket. Learn more about Fireblocks Smart Transfers [here](https://developers.fireblocks.com/docs/execute-smart-transfers). **Note:** The `DVP` value is in Early Access and should only be used if Fireblocks has enabled it in your workspace. Contact your Customer Success Manager for more information. **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor.

⌘I

TypeScript

const response: Promise<FireblocksResponse<SmartTransferTicketFilteredResponse>> = fireblocks.smartTransfer.searchTickets(smartTransferApiSearchTicketsRequest);

CompletableFuture<ApiResponse<SmartTransferTicketFilteredResponse>> response = fireblocks.smartTransfer().searchTickets(q, statuses, networkId, createdByMe, expiresAfter, expiresBefore, type, externalRefId, after, limit, sortBy, order);

response = fireblocks.smart_transfer.search_tickets(q, statuses, network_id, created_by_me, expires_after, expires_before, type, external_ref_id, after, limit, sort_by, order);

curl --request GET \
  --url https://api.fireblocks.io/v1/smart-transfers

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/smart-transfers', 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/smart-transfers",
  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/smart-transfers"

	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/smart-transfers")

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

{
  "message": "Success",
  "after": "118320d2-761f-46c7-96cf-65e71a370b36",
  "data": [
    {
      "id": "118320d2-761f-46c7-96cf-65e71a370b36",
      "type": "ASYNC",
      "status": "DRAFT",
      "createdByNetworkId": "3eaa94c5-128b-4835-bb08-3111bb6564c7",
      "createdByNetworkIdName": "Network id name",
      "createdAt": "2023-03-01T11:23:00Z",
      "updatedAt": "2023-03-01T11:23:00Z",
      "direction": "EXCHANGE",
      "dvpExecutionStatus": "STARTED",
      "orderCreatedByNetworkId": "3eaa94c5-128b-4835-bb08-3111bb6564c7",
      "terms": [
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "status": "CREATED"
        },
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "fromNetworkIdName": "Source network profile 1",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "toNetworkIdName": "Destination network profile 1",
          "status": "FUNDING",
          "connectionId": "14817440-d5c8-4dbd-a754-ad415683610c",
          "fbTxId": "79075e8c-1fd9-4c97-9575-3bd9229e5c0d",
          "createdAt": "2023-03-01T11:23:00.000Z",
          "updatedAt": "2023-03-01T11:23:00.000Z"
        },
        {
          "id": "84601ee2-b10f-4aa8-be9c-dba259a3533a",
          "ticketId": "118320d2-761f-46c7-96cf-65e71a370b36",
          "amount": "10.00",
          "asset": "ETH",
          "fromNetworkId": "947c6115-1f5f-4fb4-9fd6-a1f9dee14670",
          "fromNetworkIdName": "Source network profile 2",
          "toNetworkId": "5d009697-c29b-48e0-aff8-1f4305d19dc2",
          "toNetworkIdName": "Destination network profile 2",
          "status": "FUNDED",
          "connectionId": "14817440-d5c8-4dbd-a754-ad415683610c",
          "fbTxId": "79075e8c-1fd9-4c97-9575-3bd9229e5c0d",
          "txHash": "0xb5c8bd9430b6cc87a0e2fe110ece6bf527fa4f170a4bc8cd032f768fc5219838",
          "createdAt": "2023-03-01T11:23:00.000Z",
          "updatedAt": "2023-03-01T11:23:00.000Z"
        }
      ],
      "expiresIn": "13",
      "expiresAt": "2023-03-01T11:23:00Z",
      "submittedAt": "2023-03-01T11:23:00Z",
      "expiredAt": "2023-03-01T11:23:00Z",
      "canceledAt": "2023-03-01T11:23:00Z",
      "fulfilledAt": "2023-03-01T11:23:00Z",
      "externalRefId": "2631ffb9d8fe47c6b0825b5be28297da",
      "note": "Random note",
      "canceledByNetworkIdName": "Network id name",
      "canceledByMe": true,
      "createdByMe": true
    }
  ]
}

{
  "message": "You do not have permission to execute this action",
  "code": 3002
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Query Parameters

Response