How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

fireblocks Off Exchange API

The Off Exchange API from fireblocks — 5 operation(s) for off exchange.

fireblocks Off Exchange API is one of 35 APIs that Fireblocks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Off Exchange. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a JSON-LD context.

This API exposes 5 operations across 5 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.8.0.

Requests are made against 2 base URLs: https://api.fireblocks.io/v1, https://sandbox-api.fireblocks.io/v1.

5 operations 5 paths 40 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.8.0
Base URL
https://api.fireblocks.io/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

fireblocks Off Exchange API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerTokenAuth). An API key is passed in the header as X-API-Key (ApiKeyAuth).

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Off Exchange 5
POST
/off_exchange/add
Add Collateral
addOffExchange 1 param body → 200default
POST
/off_exchange/remove
Remove Collateral
removeOffExchange 1 param body → 200default
POST
/off_exchange/settlements/trader
Create Settlement for a Trader
settleOffExchangeTrades 1 param body → 201default
GET
/off_exchange/settlements/transactions
Get Settlements Transactions
getOffExchangeSettlementTransactions 1 param → 200default
GET
/off_exchange/collateral_accounts/{mainExchangeAccountId}
Find a specific collateral exchange account
getOffExchangeCollateralAccounts 1 param → 200default

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are TransactionRequest (26 properties), TravelRuleCreateTransactionRequest (20 properties), TravelRuleGeographicAddress (16 properties), ExchangeAccount (9 properties). Each schema is shown below with its type and property counts.

TravelRuleCreateTransactionRequest
object
20 properties 2 required
TransactionOperation
string
TRANSFER - The default value for an operation. Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All…
TravelRulePersons
object
ExchangeType
string
Exchange account's type
RemoveCollateralRequestBody
object
2 properties
TravelRulePiiIVMS
object
3 properties
ExchangeTradingAccount
object
3 properties
SystemMessageInfo
object
2 properties
UnsignedMessage
object
6 properties 1 required
TravelRuleNationalIdentification
object
Represents a national identifier for a person or entity
4 properties
AddCollateralRequestBody
object
2 properties
TravelRuleGeographicAddress
object
16 properties
TransferPeerPathType
string
CreateTransactionResponse
object
3 properties
TransactionRequest
object
26 properties
TravelRuleOwnershipProof
object
7 properties
DestinationTransferPeerPath
object
The destination of the transaction.
7 properties 1 required
SettlementResponse
object
5 properties
TravelRuleLegalPersonNameIdentifier
object
2 properties
TravelRuleNaturalNameIdentifier
object
3 properties
TravelRuleDateAndPlaceOfBirth
object
Represents the date and place of birth for a natural person
2 properties
ExtraParameters
object
Additional protocol and operation-specific key-value parameters: - For UTXO-based blockchain input selection, add the key inputsSelection with the value set to…
6 properties
ToCollateralTransaction
object
5 properties
PreHash
object
The prehash object for ECDSA RAW signing requests. The prehash object contains the content to sign (the actual message in hex representation) and the hashing a…
2 properties 2 required
OneTimeAddress
object
2 properties 1 required
ExchangeAsset
object
6 properties
UnspentInput
object
A representation of an Unspent Transaction Output (UTXO).
2 properties
TransactionRequestDestination
object
2 properties
TravelRuleNaturalPerson
object
7 properties
NodeControls
object
Configure special node requirements. - For routing transactions to a custom node, set the type to NODEROUTER and the tag to the pre-configured tag value. - For…
2 properties
TravelRulePerson
object
2 properties
ToExchangeTransaction
object
4 properties
TravelRuleNaturalPersonNameIdentifier
object
3 properties
SettlementRequestBody
object
1 property
TransferPeerPathSubType
string
SourceTransferPeerPath
object
The source of the transaction.
6 properties 1 required
TravelRuleLegalPerson
object
6 properties
ExchangeSettlementTransactionsResponse
object
2 properties
ExchangeAccount
object
9 properties
TravelRuleTransactionBlockchainInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fireblocks-off-exchange-api-openapi.yml Raw ↑

Other APIs Fireblocks publishes across the network.

Fireblocks Vaults API
Fireblocks Transactions API
Fireblocks Tokenization API
Fireblocks Staking API
Fireblocks NFTs API
Fireblocks Compliance and Policy API
Fireblocks Gas Station API
Fireblocks Webhooks API
fireblocks Approval Requests API
fireblocks Blockchains & Assets API
fireblocks Connected Accounts (Beta) API
fireblocks Contract Interactions API
Where this information came from

This is an independent, third-party profile of fireblocks Off Exchange API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.