Skip to main content
GET
/
smart-transfers
TypeScript
const response: Promise<FireblocksResponse<SmartTransferTicketFilteredResponse>> = fireblocks.smartTransfer.searchTickets(smartTransferApiSearchTicketsRequest);
{
  "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
    }
  ]
}

Query Parameters

​
q
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