@signum-tech/sdk
v0.4.0
Published
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@signum-tech/sdk* API.
Downloads
229
Readme
@signum-tech/sdk
Developer-friendly & type-safe Typescript SDK specifically catered to leverage @signum-tech/sdk API.
[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
Summary
Signum Identity Platform API: ## Overview
Signum is an omnichain identity and compliance platform built on LayerZero V2. It provides federated identity management, KYC-based attestations, and tokenized asset lifecycle management across all LayerZero-connected chains (EVM and Solana).
Architecture
The API uses a CQRS pattern for on-chain operations:
- Write operations (attestations, transfers, wallet creation) return
202 Accepted - Commands are published to Kafka and processed by dedicated workers
- Workers interact with chains via
@signum-tech/layerzero-sdk - Poll the resource endpoint for completion status
Authentication
The API supports two authentication modes:
Mode 1: JWT Bearer Token
Used by the Signum Enterprise Dashboard and user-facing flows.
Obtain tokens via POST /auth/login or POST /oauth/token.
Pass as Authorization: Bearer <token> header.
Mode 2: API Key
Used by third-party integrations. API keys are org-scoped and carry
permission grants (e.g., read:org, write:assets, write:attestations).
Create keys via POST /orgs/:orgId/api-keys.
Pass as x-api-key: <key> header.
Role Restrictions
Users with investor or client roles cannot authenticate.
They exist as attestable entities managed by their organization.
| Role | Login | API Access | Dashboard | |------|-------|------------|-----------| | admin | Yes | Full | Yes | | issuer | Yes | Full | Yes | | verifier | Yes | Read-only | Yes | | investor | No | None | No | | client | No | None | No |
Table of Contents
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @signum-tech/sdkPNPM
pnpm add @signum-tech/sdkBun
bun add @signum-tech/sdkYarn
yarn add @signum-tech/sdk[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use
await import("@signum-tech/sdk")to import and use this package.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { Signum } from "@signum-tech/sdk";
const signum = new Signum();
async function run() {
const result = await signum.health.getHealth();
console.log(result);
}
run();
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ---- | ----------- |
| bearerAuth | http | HTTP Bearer |
To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:
import { Signum } from "@signum-tech/sdk";
const signum = new Signum({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await signum.health.getHealth();
console.log(result);
}
run();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { Signum } from "@signum-tech/sdk";
const signum = new Signum();
async function run() {
const result = await signum.organizations.getOrgs({});
console.log(result);
}
run();
Available Resources and Operations
AccountTimeseries
- getAccountsHoldings - My holdings across all wallets and chains
- getAccountsHoldingsHistory - My holdings over time
- getAccountsTransactions - My transaction history
- getAccountsTransfers - My transfer events
- getAccountsLedger - My asset ledger
- getAccountsFills - My market fill history
- getAccountsOrdersHistory - My order lifecycle history
- getAccountsPortfolio - My portfolio summary
Accounts
- getAccounts - Get all chain accounts
- postAccountsWallets - Create embedded wallets
- getAccountsWallets - Get embedded wallets
- postAccountsWalletsSync - Sync wallets from Privy
- getAccountsWalletsAll - Get all chain wallets
- postAccountsEvmEmbedded - Create EVM embedded wallet
- getAccountsEvm - Get EVM wallets
- postAccountsEvmNonce - Generate verification nonce
- postAccountsEvmLink - Link EVM wallet
- deleteAccountsEvmByAddress - Unlink EVM wallet
- getAccountsSolana - Get Solana wallets
- postAccountsSolanaNonce - Generate Solana verification nonce
- postAccountsSolanaLink - Link Solana wallet
- deleteAccountsSolanaByAddress - Unlink Solana wallet
- getAccountsSummary - Get accounts summary
Assets
- getOrgsByOrgIdAssets - List organization assets
- postOrgsByOrgIdAssets - Create a new asset
- getOrgsByOrgIdAssetsByAssetId - Get asset details
- patchOrgsByOrgIdAssetsByAssetId - Update asset
- getOrgsByOrgIdAssetsByAssetIdDocuments - List asset documents
- postOrgsByOrgIdAssetsByAssetIdDocuments - Upload asset document
- getOrgsByOrgIdAssetsByAssetIdHolders - List asset holders
- getOrgsByOrgIdAssetsByAssetIdEscrows - List CRE escrow records
- getOrgsByOrgIdAssetsByAssetIdLoans - List CRE loan records
- getOrgsByOrgIdAssetsByAssetIdCollateral - List CRE collateral positions
- getOrgsByOrgIdAssetsByAssetIdReo - List CRE REO assets
- postOrgsByOrgIdAssetsByAssetIdDeploy - Deploy asset to chain
- postOrgsByOrgIdAssetsByAssetIdAllocate - Batch allocate tokens to users
Attestations
- getAttestations - List user attestations
- postAttestations - Create attestation (async)
- getAttestationsById - Get attestation by ID
- deleteAttestationsById - Revoke attestation (async)
- getAttestationsByIdAnchors - List attestation anchors
- getAttestationsByIdEvents - List attestation events
- getAttestationsByIdVerify - Verify attestation hash
Auth
- postAuthRegister - Register new user
- postAuthLogin - Login user
- postAuthRefresh - Refresh tokens
- getAuthMe - Get current user
- patchAuthMe - Update current user profile
- getAuthMeOrg - Get current user with organization
- postAuthLogout - Logout user
- postAuthForgotPassword - Request password reset
- postAuthResetPassword - Reset password
- getAuthInviteInfo - Get invitation info
- postAuthAcceptInvite - Accept invitation
- postAuthVerifyEmail - Verify email address
- postAuthResendVerification - Resend verification email
Bridge
- postOrgsByOrgIdAssetsByAssetIdBridge - Initiate cross-chain bridge (CQRS)
- getOrgsByOrgIdAssetsByAssetIdBridgeQuote - Get bridge fee quote
- getOrgsByOrgIdBridgeHistory - List bridge transactions
ChainEvents
- getChainEvents - List chain events
- getChainEventsById - Get chain event by ID
- getChainEventsByTxByTxHash - Get chain events by transaction hash
Chains
- getChains - List supported chains
- getChainsByEid - Get chain by EID
- postChainsSync - Sync chain registry (admin)
Compliance
- getOrgsByOrgIdAssetsByAssetIdCompliancePolicy - Get asset compliance policy
- postOrgsByOrgIdAssetsByAssetIdCompliancePolicy - Update asset compliance policy
- getComplianceTransferRejections - Query transfer rejections
- getComplianceDossierByWalletAddress - Generate compliance dossier
- postComplianceCheck - Queue compliance check (async)
- getComplianceByWallet - Get wallet compliance status
Distributions
- getOrgsByOrgIdAssetsByAssetIdDistributions
- postOrgsByOrgIdAssetsByAssetIdDistributions
- getOrgsByOrgIdAssetsByAssetIdDistributionsByDistId
- postOrgsByOrgIdAssetsByAssetIdDistributionsByDistIdActivate
Fees
Health
- getHealth - Health check
- getHealthDeep - Deep health check
Jurisdictions
- getJurisdictions - List jurisdictions
- getJurisdictionsByAlpha2 - Get jurisdiction details
Kyc
- getKycStatus - Get KYC status
- postKycInitiate - Initiate KYC verification
- postKycAccessToken - Get SDK access token
- postKycWebhookByProvider - KYC webhook
- postKycMockApprove - Mock approve (dev only)
- postKycMockReject - Mock reject (dev only)
- getKycProvider - Get provider info
Markets
- postOrgsByOrgIdAssetsByAssetIdMarkets - Deploy a market for an asset
- getOrgsByOrgIdAssetsByAssetIdMarkets - List markets for an asset
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketId - Get market details
- postOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdDepositHypercore - Deposit USDC to register deployer on HyperCore
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrderbook - Get aggregated orderbook
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrders - List orders for a market
- postOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrders - Place a limit order (CQRS)
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdTrades - List trades (fills) for a market
- deleteOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrdersByOrderId - Cancel an order (CQRS)
- getMarkets - Discover public markets
Mfa
- postAuthMfaEnroll - Start MFA enrollment
- postAuthMfaEnrollVerify - Confirm MFA enrollment
- postAuthMfaVerify - Verify MFA challenge
- getAuthMfaStatus - Get MFA status
- postAuthMfaBackupCodes - Regenerate backup codes
- deleteAuthMfa - Disable MFA
Nav
- getOrgsByOrgIdAssetsByAssetIdNavLatest
- getOrgsByOrgIdAssetsByAssetIdNavHistory
- postOrgsByOrgIdAssetsByAssetIdNavPublish
- postOrgsByOrgIdAssetsByAssetIdNavConfigure
OAuth
- getOauthAuthorize - OAuth2 Authorization
- postOauthAuthorizeCallback - Authorization callback
- postOauthToken - Token exchange
- postOauthRevoke - Revoke token
- getOauthUserinfo - OIDC UserInfo
OAuthManagement
- postOrgsByOrgIdOauthClients - Create OAuth client
- getOrgsByOrgIdOauthClients - List OAuth clients
- getOrgsByOrgIdOauthClientsByClientId - Get OAuth client details
- putOrgsByOrgIdOauthClientsByClientId - Update OAuth client
- deleteOrgsByOrgIdOauthClientsByClientId - Delete OAuth client
- postOrgsByOrgIdOauthClientsByClientIdRotateSecret - Rotate OAuth client secret
- getOrgsByOrgIdOauthBranding - Get SSO branding
- putOrgsByOrgIdOauthBranding - Update SSO branding
- getOrgsByOrgIdOauthDomains - List whitelisted domains
- putOrgsByOrgIdOauthDomains - Update whitelisted domains
Organizations
- getOrgs - List organizations
- postOrgs - Create a new organization
- getOrgsByOrgId - Get organization details
- patchOrgsByOrgId - Update organization metadata
- getOrgsByOrgIdMembers - List organization members
- postOrgsByOrgIdMembers - Add member to organization
- postOrgsByOrgIdMembersInvite - Invite member by email
- postOrgsByOrgIdInviteEligibility - Check invite eligibility
- getOrgsByOrgIdInvitations - List invitations
- postOrgsByOrgIdInvitationsByInvitationIdResend - Resend invitation
- postOrgsByOrgIdInvitationsByInvitationIdRevoke - Revoke invitation
- putOrgsByOrgIdMembersByUserId - Update member role
- deleteOrgsByOrgIdMembersByUserId - Remove member from organization
- getOrgsByOrgIdWallets - List organization wallets
- postOrgsByOrgIdWallets - Add wallet to organization
- getOrgsByOrgIdChains - List enabled chains for organization
- postOrgsByOrgIdChains - Enable a chain for organization
- deleteOrgsByOrgIdChainsByChainId - Disable a chain for organization
- getOrgsByOrgIdSummary - Get organization summary
- getOrgsByOrgIdApiKeys - List API keys
- postOrgsByOrgIdApiKeys - Create API key
- deleteOrgsByOrgIdApiKeysByKeyId - Revoke API key
- getOrgsByOrgIdSubOrgs - List sub-organizations
- postOrgsByOrgIdSubOrgs - Create sub-organization
- getOrgsByOrgIdHierarchy - Get organization hierarchy
- putOrgsByOrgIdSubOrgsBySubOrgIdMove - Move sub-organization
- postOrgsByOrgIdMembersByUserIdAttest - Attest member wallets on behalf of org
- getOrgsByOrgIdAttestations - List attestations for org members
- getOrgsByOrgIdTransactions - List org transactions
- getOrgsByOrgIdChainTransactions - List org chain transactions
- getOrgsByOrgIdAuditLogs - List org audit logs
- getOrgsByOrgIdAuditLogsExport - Export audit logs as CSV
- getOrgsByOrgIdAuditLogsArchive - Query archived audit logs
- getOrgsByOrgIdUsers - List org users with details
- getOrgsByOrgIdUsersByUserIdWallets - List user wallets
- getOrgsByOrgIdUsersByUserIdHoldings - List user holdings
- getOrgsByOrgIdUsersByUserIdBalanceSummary - Get user balance summary
- getOrgsByOrgIdNetworkMode - Get organization network mode
- putOrgsByOrgIdNetworkMode - Set organization network mode
- postOrgsByOrgIdServerWallet - Provision server wallets for organization
- getOrgsByOrgIdServerWallet - Get organization server wallets
- getOrgsByOrgIdIssuer - Get issuer status for organization
- deleteOrgsByOrgIdIssuer - Deactivate issuer registration
- postOrgsByOrgIdIssuerRegister - Register organization as an issuer
- getOrgsPermissionScopes - List available API key permission scopes
- patchOrgsByOrgIdSecurity - Update org security policy (admin only, JWT only)
- getOrgsByOrgIdMembersByUserIdHoldings - Get member token holdings
- getOrgsByOrgIdCompliance - Get organization compliance config
- putOrgsByOrgIdCompliance - Update organization compliance config
- getOrgsByOrgIdComplianceStats - Organization compliance stats
PublicMarketData
- getPublicTickers - All market tickers
- getPublicTickerByMarketId - Single market ticker
- getPublicTickersHistory - OHLCV candle history (via SAMPLE BY)
- getPublicTradesByMarketId - Recent trades — anonymized, zero PII
- getPublicBookByMarketId - L2 order book — aggregated depth
- getPublicBookByMarketIdL1 - L1 top-of-book — best bid/ask, spread
- getPublicBookByMarketIdL3 - L3 full order-by-order book — zero PII
- getPublicStatsByMarketId - 24h market stats — volume, VWAP, high/low
Timeseries
- getOrgsByOrgIdHoldings - Org-wide holdings rollup
- getOrgsByOrgIdHoldingsByUserId - Single user holdings
- getOrgsByOrgIdHoldingsHistory - Holdings snapshots over time
- getOrgsByOrgIdLedger - Unified asset ledger query
- getOrgsByOrgIdLedgerExport - Export ledger as CSV
- getOrgsByOrgIdTransferEvents - Transfer events with DECIMAL amounts
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdFills - Market fill history
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrdersHistory - Order lifecycle history
- getOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrderbookL3 - Enriched L3 orderbook (includes maker addresses)
Transfers
- getTransfers - List transfers (org-scoped)
- postTransfers - Create transfer (async)
- getTransfersByTransferId - Get transfer status
Ui
Uploads
- postUploadsPresigned - Get presigned upload URL
Vaults
- getOrgsByOrgIdAssetsByAssetIdVault
- getOrgsByOrgIdAssetsByAssetIdVaultStatus
- getOrgsByOrgIdAssetsByAssetIdVaultEpochs
- postOrgsByOrgIdAssetsByAssetIdVaultDeploy
- postOrgsByOrgIdAssetsByAssetIdVaultSettle
- postOrgsByOrgIdAssetsByAssetIdVaultPause
- postOrgsByOrgIdAssetsByAssetIdVaultDeprecate
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
accountsDeleteAccountsEvmByAddress- Unlink EVM walletaccountsDeleteAccountsSolanaByAddress- Unlink Solana walletaccountsGetAccounts- Get all chain accountsaccountsGetAccountsEvm- Get EVM walletsaccountsGetAccountsSolana- Get Solana walletsaccountsGetAccountsSummary- Get accounts summaryaccountsGetAccountsWallets- Get embedded walletsaccountsGetAccountsWalletsAll- Get all chain walletsaccountsPostAccountsEvmEmbedded- Create EVM embedded walletaccountsPostAccountsEvmLink- Link EVM walletaccountsPostAccountsEvmNonce- Generate verification nonceaccountsPostAccountsSolanaLink- Link Solana walletaccountsPostAccountsSolanaNonce- Generate Solana verification nonceaccountsPostAccountsWallets- Create embedded walletsaccountsPostAccountsWalletsSync- Sync wallets from PrivyaccountTimeseriesGetAccountsFills- My market fill historyaccountTimeseriesGetAccountsHoldings- My holdings across all wallets and chainsaccountTimeseriesGetAccountsHoldingsHistory- My holdings over timeaccountTimeseriesGetAccountsLedger- My asset ledgeraccountTimeseriesGetAccountsOrdersHistory- My order lifecycle historyaccountTimeseriesGetAccountsPortfolio- My portfolio summaryaccountTimeseriesGetAccountsTransactions- My transaction historyaccountTimeseriesGetAccountsTransfers- My transfer eventsassetsGetOrgsByOrgIdAssets- List organization assetsassetsGetOrgsByOrgIdAssetsByAssetId- Get asset detailsassetsGetOrgsByOrgIdAssetsByAssetIdCollateral- List CRE collateral positionsassetsGetOrgsByOrgIdAssetsByAssetIdDocuments- List asset documentsassetsGetOrgsByOrgIdAssetsByAssetIdEscrows- List CRE escrow recordsassetsGetOrgsByOrgIdAssetsByAssetIdHolders- List asset holdersassetsGetOrgsByOrgIdAssetsByAssetIdLoans- List CRE loan recordsassetsGetOrgsByOrgIdAssetsByAssetIdReo- List CRE REO assetsassetsPatchOrgsByOrgIdAssetsByAssetId- Update assetassetsPostOrgsByOrgIdAssets- Create a new assetassetsPostOrgsByOrgIdAssetsByAssetIdAllocate- Batch allocate tokens to usersassetsPostOrgsByOrgIdAssetsByAssetIdDeploy- Deploy asset to chainassetsPostOrgsByOrgIdAssetsByAssetIdDocuments- Upload asset documentattestationsDeleteAttestationsById- Revoke attestation (async)attestationsGetAttestations- List user attestationsattestationsGetAttestationsById- Get attestation by IDattestationsGetAttestationsByIdAnchors- List attestation anchorsattestationsGetAttestationsByIdEvents- List attestation eventsattestationsGetAttestationsByIdVerify- Verify attestation hashattestationsPostAttestations- Create attestation (async)authGetAuthInviteInfo- Get invitation infoauthGetAuthMe- Get current userauthGetAuthMeOrg- Get current user with organizationauthPatchAuthMe- Update current user profileauthPostAuthAcceptInvite- Accept invitationauthPostAuthForgotPassword- Request password resetauthPostAuthLogin- Login userauthPostAuthLogout- Logout userauthPostAuthRefresh- Refresh tokensauthPostAuthRegister- Register new userauthPostAuthResendVerification- Resend verification emailauthPostAuthResetPassword- Reset passwordauthPostAuthVerifyEmail- Verify email addressbridgeGetOrgsByOrgIdAssetsByAssetIdBridgeQuote- Get bridge fee quotebridgeGetOrgsByOrgIdBridgeHistory- List bridge transactionsbridgePostOrgsByOrgIdAssetsByAssetIdBridge- Initiate cross-chain bridge (CQRS)chainEventsGetChainEvents- List chain eventschainEventsGetChainEventsById- Get chain event by IDchainEventsGetChainEventsByTxByTxHash- Get chain events by transaction hashchainsGetChains- List supported chainschainsGetChainsByEid- Get chain by EIDchainsPostChainsSync- Sync chain registry (admin)complianceGetComplianceByWallet- Get wallet compliance statuscomplianceGetComplianceDossierByWalletAddress- Generate compliance dossiercomplianceGetComplianceTransferRejections- Query transfer rejectionscomplianceGetOrgsByOrgIdAssetsByAssetIdCompliancePolicy- Get asset compliance policycompliancePostComplianceCheck- Queue compliance check (async)compliancePostOrgsByOrgIdAssetsByAssetIdCompliancePolicy- Update asset compliance policydistributionsGetOrgsByOrgIdAssetsByAssetIdDistributionsdistributionsGetOrgsByOrgIdAssetsByAssetIdDistributionsByDistIddistributionsPostOrgsByOrgIdAssetsByAssetIdDistributionsdistributionsPostOrgsByOrgIdAssetsByAssetIdDistributionsByDistIdActivatefeesGetOrgsByOrgIdFeeDistributionsfeesGetOrgsByOrgIdFeeSplitsfeesPostOrgsByOrgIdAssetsByAssetIdFeesDistributehealthGetHealth- Health checkhealthGetHealthDeep- Deep health checkjurisdictionsGetJurisdictions- List jurisdictionsjurisdictionsGetJurisdictionsByAlpha2- Get jurisdiction detailskycGetKYCProvider- Get provider infokycGetKYCStatus- Get KYC statuskycPostKYCAccessToken- Get SDK access tokenkycPostKYCInitiate- Initiate KYC verificationkycPostKYCMockApprove- Mock approve (dev only)kycPostKYCMockReject- Mock reject (dev only)kycPostKYCWebhookByProvider- KYC webhookmarketsDeleteOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrdersByOrderId- Cancel an order (CQRS)marketsGetMarkets- Discover public marketsmarketsGetOrgsByOrgIdAssetsByAssetIdMarkets- List markets for an assetmarketsGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketId- Get market detailsmarketsGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrderbook- Get aggregated orderbookmarketsGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrders- List orders for a marketmarketsGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdTrades- List trades (fills) for a marketmarketsPostOrgsByOrgIdAssetsByAssetIdMarkets- Deploy a market for an assetmarketsPostOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdDepositHypercore- Deposit USDC to register deployer on HyperCoremarketsPostOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrders- Place a limit order (CQRS)mfaDeleteAuthMFA- Disable MFAmfaGetAuthMFAStatus- Get MFA statusmfaPostAuthMFABackupCodes- Regenerate backup codesmfaPostAuthMFAEnroll- Start MFA enrollmentmfaPostAuthMFAEnrollVerify- Confirm MFA enrollmentmfaPostAuthMFAVerify- Verify MFA challengenavGetOrgsByOrgIdAssetsByAssetIdNAVHistorynavGetOrgsByOrgIdAssetsByAssetIdNAVLatestnavPostOrgsByOrgIdAssetsByAssetIdNAVConfigurenavPostOrgsByOrgIdAssetsByAssetIdNAVPublishoAuthGetOauthAuthorize- OAuth2 AuthorizationoAuthGetOauthUserinfo- OIDC UserInfooAuthManagementDeleteOrgsByOrgIdOauthClientsByClientId- Delete OAuth clientoAuthManagementGetOrgsByOrgIdOauthBranding- Get SSO brandingoAuthManagementGetOrgsByOrgIdOauthClients- List OAuth clientsoAuthManagementGetOrgsByOrgIdOauthClientsByClientId- Get OAuth client detailsoAuthManagementGetOrgsByOrgIdOauthDomains- List whitelisted domainsoAuthManagementPostOrgsByOrgIdOauthClients- Create OAuth clientoAuthManagementPostOrgsByOrgIdOauthClientsByClientIdRotateSecret- Rotate OAuth client secretoAuthManagementPutOrgsByOrgIdOauthBranding- Update SSO brandingoAuthManagementPutOrgsByOrgIdOauthClientsByClientId- Update OAuth clientoAuthManagementPutOrgsByOrgIdOauthDomains- Update whitelisted domainsoAuthPostOauthAuthorizeCallback- Authorization callbackoAuthPostOauthRevoke- Revoke tokenoAuthPostOauthToken- Token exchangeorganizationsDeleteOrgsByOrgIdApiKeysByKeyId- Revoke API keyorganizationsDeleteOrgsByOrgIdChainsByChainId- Disable a chain for organizationorganizationsDeleteOrgsByOrgIdIssuer- Deactivate issuer registrationorganizationsDeleteOrgsByOrgIdMembersByUserId- Remove member from organizationorganizationsGetOrgs- List organizationsorganizationsGetOrgsByOrgId- Get organization detailsorganizationsGetOrgsByOrgIdApiKeys- List API keysorganizationsGetOrgsByOrgIdAttestations- List attestations for org membersorganizationsGetOrgsByOrgIdAuditLogs- List org audit logsorganizationsGetOrgsByOrgIdAuditLogsArchive- Query archived audit logsorganizationsGetOrgsByOrgIdAuditLogsExport- Export audit logs as CSVorganizationsGetOrgsByOrgIdChains- List enabled chains for organizationorganizationsGetOrgsByOrgIdChainTransactions- List org chain transactionsorganizationsGetOrgsByOrgIdCompliance- Get organization compliance configorganizationsGetOrgsByOrgIdComplianceStats- Organization compliance statsorganizationsGetOrgsByOrgIdHierarchy- Get organization hierarchyorganizationsGetOrgsByOrgIdInvitations- List invitationsorganizationsGetOrgsByOrgIdIssuer- Get issuer status for organizationorganizationsGetOrgsByOrgIdMembers- List organization membersorganizationsGetOrgsByOrgIdMembersByUserIdHoldings- Get member token holdingsorganizationsGetOrgsByOrgIdNetworkMode- Get organization network modeorganizationsGetOrgsByOrgIdServerWallet- Get organization server walletsorganizationsGetOrgsByOrgIdSubOrgs- List sub-organizationsorganizationsGetOrgsByOrgIdSummary- Get organization summaryorganizationsGetOrgsByOrgIdTransactions- List org transactionsorganizationsGetOrgsByOrgIdUsers- List org users with detailsorganizationsGetOrgsByOrgIdUsersByUserIdBalanceSummary- Get user balance summaryorganizationsGetOrgsByOrgIdUsersByUserIdHoldings- List user holdingsorganizationsGetOrgsByOrgIdUsersByUserIdWallets- List user walletsorganizationsGetOrgsByOrgIdWallets- List organization walletsorganizationsGetOrgsPermissionScopes- List available API key permission scopesorganizationsPatchOrgsByOrgId- Update organization metadataorganizationsPatchOrgsByOrgIdSecurity- Update org security policy (admin only, JWT only)organizationsPostOrgs- Create a new organizationorganizationsPostOrgsByOrgIdApiKeys- Create API keyorganizationsPostOrgsByOrgIdChains- Enable a chain for organizationorganizationsPostOrgsByOrgIdInvitationsByInvitationIdResend- Resend invitationorganizationsPostOrgsByOrgIdInvitationsByInvitationIdRevoke- Revoke invitationorganizationsPostOrgsByOrgIdInviteEligibility- Check invite eligibilityorganizationsPostOrgsByOrgIdIssuerRegister- Register organization as an issuerorganizationsPostOrgsByOrgIdMembers- Add member to organizationorganizationsPostOrgsByOrgIdMembersByUserIdAttest- Attest member wallets on behalf of orgorganizationsPostOrgsByOrgIdMembersInvite- Invite member by emailorganizationsPostOrgsByOrgIdServerWallet- Provision server wallets for organizationorganizationsPostOrgsByOrgIdSubOrgs- Create sub-organizationorganizationsPostOrgsByOrgIdWallets- Add wallet to organizationorganizationsPutOrgsByOrgIdCompliance- Update organization compliance configorganizationsPutOrgsByOrgIdMembersByUserId- Update member roleorganizationsPutOrgsByOrgIdNetworkMode- Set organization network modeorganizationsPutOrgsByOrgIdSubOrgsBySubOrgIdMove- Move sub-organizationpublicMarketDataGetPublicBookByMarketId- L2 order book — aggregated depthpublicMarketDataGetPublicBookByMarketIdL1- L1 top-of-book — best bid/ask, spreadpublicMarketDataGetPublicBookByMarketIdL3- L3 full order-by-order book — zero PIIpublicMarketDataGetPublicStatsByMarketId- 24h market stats — volume, VWAP, high/lowpublicMarketDataGetPublicTickerByMarketId- Single market tickerpublicMarketDataGetPublicTickers- All market tickerspublicMarketDataGetPublicTickersHistory- OHLCV candle history (via SAMPLE BY)publicMarketDataGetPublicTradesByMarketId- Recent trades — anonymized, zero PIItimeseriesGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdFills- Market fill historytimeseriesGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrderbookL3- Enriched L3 orderbook (includes maker addresses)timeseriesGetOrgsByOrgIdAssetsByAssetIdMarketsByMarketIdOrdersHistory- Order lifecycle historytimeseriesGetOrgsByOrgIdHoldings- Org-wide holdings rolluptimeseriesGetOrgsByOrgIdHoldingsByUserId- Single user holdingstimeseriesGetOrgsByOrgIdHoldingsHistory- Holdings snapshots over timetimeseriesGetOrgsByOrgIdLedger- Unified asset ledger querytimeseriesGetOrgsByOrgIdLedgerExport- Export ledger as CSVtimeseriesGetOrgsByOrgIdTransferEvents- Transfer events with DECIMAL amountstransfersGetTransfers- List transfers (org-scoped)transfersGetTransfersByTransferId- Get transfer statustransfersPostTransfers- Create transfer (async)uiGetConsentuiGetLoginuiGetLoginSuccessuiGetRegisteruiPostConsentuiPostLoginuiPostRegisteruploadsPostUploadsPresigned- Get presigned upload URLvaultsGetOrgsByOrgIdAssetsByAssetIdVaultvaultsGetOrgsByOrgIdAssetsByAssetIdVaultEpochsvaultsGetOrgsByOrgIdAssetsByAssetIdVaultStatusvaultsPostOrgsByOrgIdAssetsByAssetIdVaultDeployvaultsPostOrgsByOrgIdAssetsByAssetIdVaultDeprecatevaultsPostOrgsByOrgIdAssetsByAssetIdVaultPausevaultsPostOrgsByOrgIdAssetsByAssetIdVaultSettle
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Signum } from "@signum-tech/sdk";
const signum = new Signum();
async function run() {
const result = await signum.health.getHealth({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Signum } from "@signum-tech/sdk";
const signum = new Signum({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await signum.health.getHealth();
console.log(result);
}
run();
Error Handling
SignumError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
Example
import { Signum } from "@signum-tech/sdk";
import * as errors from "@signum-tech/sdk/models/errors";
const signum = new Signum();
async function run() {
try {
const result = await signum.auth.postAuthRegister({
email: "[email protected]",
password: "nczL2SjzuV_kjB1",
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.SignumError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.SignumProblemDetailsError) {
console.log(error.data$.type); // string
console.log(error.data$.title); // string
console.log(error.data$.status); // number
console.log(error.data$.detail); // string
console.log(error.data$.instance); // string
}
}
}
}
run();
Error Classes
Primary error:
SignumError: The base class for HTTP error responses.
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from SignumError:
SignumProblemDetailsError: RFC 9457 problem+json. Extra fields (prerequisites, dependencyChain, retryAfter, details) may be present. Applicable to 68 of 209 methods.*GetOauthAuthorizeBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOauthAuthorizeCallbackBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOauthTokenBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdOauthClientsBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PutOrgsByOrgIdOauthClientsByClientIdBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdOauthClientsByClientIdRotateSecretBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostKycAccessTokenBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostKycWebhookByProviderBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostKycMockApproveBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostKycMockRejectBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostAttestationsBadRequestUnauthorizedError: Response. Status code400. Applicable to 1 of 209 methods.*DeleteAttestationsByIdBadRequestUnauthorizedError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PatchOrgsByOrgIdBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdMembersBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdMembersInviteBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdInvitationsByInvitationIdResendBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PostOrgsByOrgIdInvitationsByInvitationIdRevokeBadRequestError: Response. Status code400. Applicable to 1 of 209 methods.*PutOrgsByOrgIdMembersByUserIdBadRequestError: Response. Status code400. Applicable to 1 o
