ReportsBetaApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
createReport	POST /reports	Create a report
getReport	GET /reports/{reportId}	Get report status
listReports	GET /reports	List reports

createReport

CompletableFuture<ApiResponse> createReport createReport(body, idempotencyKey)

Create a report

Creates a new asynchronous report job and returns a receipt containing the report ID. Poll `GET /v1/reports/{reportId}` to check status. When `status` is `COMPLETED`, the poll response includes a fresh pre-signed download URL in `links.downloadUrl`. Note: These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Viewer and above.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.ReportsBetaApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        CreateAddressesReportRequest body = new CreateAddressesReportRequest(); // CreateAddressesReportRequest | 
        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<CreateReportResponse>> response = fireblocks.reportsBeta().createReport(body, 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 ReportsBetaApi#createReport");
            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 ReportsBetaApi#createReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
body	CreateAddressesReportRequest
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]

Return type

CompletableFuture<ApiResponse<CreateReportResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Report job accepted and queued for processing	* X-Request-ID -
409	A report with the same type and filters is already being processed	* X-Request-ID -
0	Error Response	* X-Request-ID -

getReport

CompletableFuture<ApiResponse> getReport getReport(reportId)

Get report status

Returns the current status of a report job. Check the `status` field to determine the outcome. When `status` is `COMPLETED`, the response includes a fresh pre-signed download URL in `links.downloadUrl` (TTL ~1 hour). Re-poll this endpoint to obtain a new URL after expiry. When `status` is `FAILED`, the `failedAt` timestamp indicates when the failure occurred. Note: These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Viewer and above.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.ReportsBetaApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String reportId = "0190b3c2-7e4a-7c31-9f2a-1b6d8e5a0c11"; // String | The unique identifier of the report job
        try {
            CompletableFuture<ApiResponse<ReportJobResponse>> response = fireblocks.reportsBeta().getReport(reportId);
            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 ReportsBetaApi#getReport");
            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 ReportsBetaApi#getReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
reportId	String	The unique identifier of the report job

Return type

CompletableFuture<ApiResponse<ReportJobResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Report job details	* X-Request-ID -
0	Error Response	* X-Request-ID -

listReports

CompletableFuture<ApiResponse> listReports listReports(pageCursor, pageSize, sortBy, order, status, reportType)

List reports

Returns a paginated list of report jobs scoped to the calling tenant. Note: Download URLs are not included in list responses. Call `GET /v1/reports/{reportId}` to obtain a fresh signed download URL for a specific completed report. Note: These endpoints are currently in beta and might be subject to changes. Endpoint Permission: Viewer and above.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.ReportsBetaApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String pageCursor = "pageCursor_example"; // String | Opaque cursor returned from a previous list call
        Integer pageSize = 20; // Integer | Maximum number of items per page
        String sortBy = "createdAt"; // String | Field to sort by
        String order = "ASC"; // String | Sort direction
        List<ReportStatus> status = Arrays.asList(); // List<ReportStatus> | Filter by lifecycle status. Repeat the parameter to filter on multiple statuses (e.g., ?status=QUEUED&status=PROCESSING).
        List<ReportType> reportType = Arrays.asList(); // List<ReportType> | Filter by report type. Repeat the parameter to filter on multiple types.
        try {
            CompletableFuture<ApiResponse<ReportListResponse>> response = fireblocks.reportsBeta().listReports(pageCursor, pageSize, sortBy, order, status, reportType);
            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 ReportsBetaApi#listReports");
            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 ReportsBetaApi#listReports");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageCursor	String	Opaque cursor returned from a previous list call	[optional]
pageSize	Integer	Maximum number of items per page	[optional] [default to 20]
sortBy	String	Field to sort by	[optional] [default to createdAt] [enum: createdAt, completedAt]
order	String	Sort direction	[optional] [default to DESC] [enum: ASC, DESC]
status	List<ReportStatus>	Filter by lifecycle status. Repeat the parameter to filter on multiple statuses (e.g., ?status=QUEUED&status=PROCESSING).	[optional]
reportType	List<ReportType>	Filter by report type. Repeat the parameter to filter on multiple types.	[optional]

Return type

CompletableFuture<ApiResponse<ReportListResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Paginated list of report jobs	* X-Request-ID -
0	Error Response	* X-Request-ID -

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ReportsBetaApi

createReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listReports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

ReportsBetaApi.md

Latest commit

History

ReportsBetaApi.md

File metadata and controls

ReportsBetaApi

createReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listReports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details