All URIs are relative to https://developers.fireblocks.com/reference/
Method | HTTP request | Description |
---|---|---|
getApiKey | GET /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key |
getApiKeys | GET /cosigners/{cosignerId}/api_keys | Get all API keys |
getCosigner | GET /cosigners/{cosignerId} | Get cosigner |
getCosigners | GET /cosigners | Get all cosigners |
renameCosigner | PATCH /cosigners/{cosignerId} | Rename cosigner |
ApiKey getApiKey()
Get an API key by ID Note: These endpoints are currently in beta and might be subject to changes.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetApiKeyRequest, ApiKey } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: CosignersBetaApiGetApiKeyRequest = {
// string | The unique identifier of the cosigner
cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
// string | The unique identifier of the API key
apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};
fireblocks.cosignersBeta.getApiKey(body).then((res: FireblocksResponse<ApiKey>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
cosignerId | [string] | The unique identifier of the cosigner | defaults to undefined |
apiKeyId | [string] | The unique identifier of the API key | defaults to undefined |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | An ApiKey object | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiKeysPaginatedResponse getApiKeys()
Get all cosigner paired API keys (paginated) Note: These endpoints are currently in beta and might be subject to changes.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetApiKeysRequest, ApiKeysPaginatedResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: CosignersBetaApiGetApiKeysRequest = {
// string | The unique identifier of the cosigner
cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
// 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional)
order: ASC,
// string | Cursor of the required page (optional)
pageCursor: pageCursor_example,
// number | Maximum number of items in the page (optional)
pageSize: 10,
};
fireblocks.cosignersBeta.getApiKeys(body).then((res: FireblocksResponse<ApiKeysPaginatedResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
cosignerId | [string] | The unique identifier of the cosigner | defaults to undefined |
order | [**'ASC' | 'DESC'**]Array<'ASC' | 'DESC'> | ASC / DESC ordering (default DESC) |
pageCursor | [string] | Cursor of the required page | (optional) defaults to undefined |
pageSize | [number] | Maximum number of items in the page | (optional) defaults to 10 |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A paginated response containing ApiKey objects | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Cosigner getCosigner()
Get a cosigner by ID Note: These endpoints are currently in beta and might be subject to changes.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetCosignerRequest, Cosigner } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: CosignersBetaApiGetCosignerRequest = {
// string | The unique identifier of the cosigner
cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};
fireblocks.cosignersBeta.getCosigner(body).then((res: FireblocksResponse<Cosigner>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
cosignerId | [string] | The unique identifier of the cosigner | defaults to undefined |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A cosigner object | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CosignersPaginatedResponse getCosigners()
Get all workspace cosigners (paginated) Note: These endpoints are currently in beta and might be subject to changes.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetCosignersRequest, CosignersPaginatedResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: CosignersBetaApiGetCosignersRequest = {
// 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional)
order: ASC,
// string | Cursor of the required page (optional)
pageCursor: pageCursor_example,
// number | Maximum number of items in the page (optional)
pageSize: 10,
};
fireblocks.cosignersBeta.getCosigners(body).then((res: FireblocksResponse<CosignersPaginatedResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
order | [**'ASC' | 'DESC'**]Array<'ASC' | 'DESC'> | ASC / DESC ordering (default DESC) |
pageCursor | [string] | Cursor of the required page | (optional) defaults to undefined |
pageSize | [number] | Maximum number of items in the page | (optional) defaults to 10 |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A paginated response containing Cosigner objects | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Cosigner renameCosigner(renameCosigner, )
Rename a cosigner by ID Note: These endpoints are currently in beta and might be subject to changes.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiRenameCosignerRequest, Cosigner } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: CosignersBetaApiRenameCosignerRequest = {
// RenameCosigner
renameCosigner: param_value,
// string | The unique identifier of the cosigner
cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};
fireblocks.cosignersBeta.renameCosigner(body).then((res: FireblocksResponse<Cosigner>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
renameCosigner | RenameCosigner | ||
cosignerId | [string] | The unique identifier of the cosigner | defaults to undefined |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A cosigner object | * X-Request-ID - |
0 | Error Response | * X-Request-ID - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]