All URIs are relative to https://api.fireblocks.io/v1
Method | HTTP request | Description |
---|---|---|
addOffExchange | POST /off_exchange/add | add collateral |
addOffExchangeWithHttpInfo | POST /off_exchange/add | add collateral |
getOffExchangeCollateralAccounts | GET /off_exchange/collateral_accounts/{mainExchangeAccountId} | Find a specific collateral exchange account |
getOffExchangeCollateralAccountsWithHttpInfo | GET /off_exchange/collateral_accounts/{mainExchangeAccountId} | Find a specific collateral exchange account |
getOffExchangeSettlementTransactions | GET /off_exchange/settlements/transactions | get settlements transactions from exchange |
getOffExchangeSettlementTransactionsWithHttpInfo | GET /off_exchange/settlements/transactions | get settlements transactions from exchange |
removeOffExchange | POST /off_exchange/remove | remove collateral |
removeOffExchangeWithHttpInfo | POST /off_exchange/remove | remove collateral |
settleOffExchangeTrades | POST /off_exchange/settlements/trader | create settlement for a trader |
settleOffExchangeTradesWithHttpInfo | POST /off_exchange/settlements/trader | create settlement for a trader |
CompletableFuture addOffExchange(addCollateralRequestBody, idempotencyKey)
add collateral
add collateral, create deposit request
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
AddCollateralRequestBody addCollateralRequestBody = new AddCollateralRequestBody(); // AddCollateralRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<CreateTransactionResponse> result = apiInstance.addOffExchange(addCollateralRequestBody, idempotencyKey);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#addOffExchange");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
addCollateralRequestBody | AddCollateralRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<CreateTransactionResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A transaction object | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture<ApiResponse> addOffExchange addOffExchangeWithHttpInfo(addCollateralRequestBody, idempotencyKey)
add collateral
add collateral, create deposit request
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
AddCollateralRequestBody addCollateralRequestBody = new AddCollateralRequestBody(); // AddCollateralRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<ApiResponse<CreateTransactionResponse>> response = apiInstance.addOffExchangeWithHttpInfo(addCollateralRequestBody, idempotencyKey);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OffExchangesApi#addOffExchange");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#addOffExchange");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
addCollateralRequestBody | AddCollateralRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<ApiResponse<CreateTransactionResponse>>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A transaction object | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture getOffExchangeCollateralAccounts(mainExchangeAccountId)
Find a specific collateral exchange account
Returns a collateral account by mainExchangeAccountId.
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
String mainExchangeAccountId = "mainExchangeAccountId_example"; // String | The id of the main exchange account for which the requested collateral account is associated with
try {
CompletableFuture<ExchangeAccount> result = apiInstance.getOffExchangeCollateralAccounts(mainExchangeAccountId);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#getOffExchangeCollateralAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
mainExchangeAccountId | String | The id of the main exchange account for which the requested collateral account is associated with |
CompletableFuture<ExchangeAccount>
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | An ExchangeAccount object | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
CompletableFuture<ApiResponse> getOffExchangeCollateralAccounts getOffExchangeCollateralAccountsWithHttpInfo(mainExchangeAccountId)
Find a specific collateral exchange account
Returns a collateral account by mainExchangeAccountId.
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
String mainExchangeAccountId = "mainExchangeAccountId_example"; // String | The id of the main exchange account for which the requested collateral account is associated with
try {
CompletableFuture<ApiResponse<ExchangeAccount>> response = apiInstance.getOffExchangeCollateralAccountsWithHttpInfo(mainExchangeAccountId);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OffExchangesApi#getOffExchangeCollateralAccounts");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#getOffExchangeCollateralAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
mainExchangeAccountId | String | The id of the main exchange account for which the requested collateral account is associated with |
CompletableFuture<ApiResponse<ExchangeAccount>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | An ExchangeAccount object | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
CompletableFuture getOffExchangeSettlementTransactions(mainExchangeAccountId)
get settlements transactions from exchange
get settlements transactions from exchange
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
String mainExchangeAccountId = "mainExchangeAccountId_example"; // String |
try {
CompletableFuture<ExchangeSettlementTransactionsResponse> result = apiInstance.getOffExchangeSettlementTransactions(mainExchangeAccountId);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#getOffExchangeSettlementTransactions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
mainExchangeAccountId | String |
CompletableFuture<ExchangeSettlementTransactionsResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A settlement transactions | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture<ApiResponse> getOffExchangeSettlementTransactions getOffExchangeSettlementTransactionsWithHttpInfo(mainExchangeAccountId)
get settlements transactions from exchange
get settlements transactions from exchange
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
String mainExchangeAccountId = "mainExchangeAccountId_example"; // String |
try {
CompletableFuture<ApiResponse<ExchangeSettlementTransactionsResponse>> response = apiInstance.getOffExchangeSettlementTransactionsWithHttpInfo(mainExchangeAccountId);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OffExchangesApi#getOffExchangeSettlementTransactions");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#getOffExchangeSettlementTransactions");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
mainExchangeAccountId | String |
CompletableFuture<ApiResponse<ExchangeSettlementTransactionsResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A settlement transactions | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture removeOffExchange(removeCollateralRequestBody, idempotencyKey)
remove collateral
remove collateral, create withdraw request
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
RemoveCollateralRequestBody removeCollateralRequestBody = new RemoveCollateralRequestBody(); // RemoveCollateralRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<CreateTransactionResponse> result = apiInstance.removeOffExchange(removeCollateralRequestBody, idempotencyKey);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#removeOffExchange");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
removeCollateralRequestBody | RemoveCollateralRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<CreateTransactionResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A transaction object | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture<ApiResponse> removeOffExchange removeOffExchangeWithHttpInfo(removeCollateralRequestBody, idempotencyKey)
remove collateral
remove collateral, create withdraw request
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
RemoveCollateralRequestBody removeCollateralRequestBody = new RemoveCollateralRequestBody(); // RemoveCollateralRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<ApiResponse<CreateTransactionResponse>> response = apiInstance.removeOffExchangeWithHttpInfo(removeCollateralRequestBody, idempotencyKey);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OffExchangesApi#removeOffExchange");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#removeOffExchange");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
removeCollateralRequestBody | RemoveCollateralRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<ApiResponse<CreateTransactionResponse>>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A transaction object | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture settleOffExchangeTrades(settlementRequestBody, idempotencyKey)
create settlement for a trader
create settlement for a trader
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
SettlementRequestBody settlementRequestBody = new SettlementRequestBody(); // SettlementRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<SettlementResponse> result = apiInstance.settleOffExchangeTrades(settlementRequestBody, idempotencyKey);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#settleOffExchangeTrades");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
settlementRequestBody | SettlementRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<SettlementResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | A settlement object | - |
0 | Error Response | * X-Request-ID - |
CompletableFuture<ApiResponse> settleOffExchangeTrades settleOffExchangeTradesWithHttpInfo(settlementRequestBody, idempotencyKey)
create settlement for a trader
create settlement for a trader
// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.api.OffExchangesApi;
import java.util.concurrent.CompletableFuture;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
OffExchangesApi apiInstance = new OffExchangesApi(defaultClient);
SettlementRequestBody settlementRequestBody = new SettlementRequestBody(); // SettlementRequestBody |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<ApiResponse<SettlementResponse>> response = apiInstance.settleOffExchangeTradesWithHttpInfo(settlementRequestBody, idempotencyKey);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OffExchangesApi#settleOffExchangeTrades");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OffExchangesApi#settleOffExchangeTrades");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
settlementRequestBody | SettlementRequestBody | [optional] | |
idempotencyKey | String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional] |
CompletableFuture<ApiResponse<SettlementResponse>>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | A settlement object | - |
0 | Error Response | * X-Request-ID - |