Get Allocation

Authentication

❌ Account User (AccountUser)
✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Allocations:Read: Always required.

Authorizations

Authorization

string

header

required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

allocationId

string

required

Unique identifier for the allocation investment.

Required string length: 1 - 64

Response

200 - application/json

Success

A allocation investment representing funds deposited to earn interest from a DeFi protocol.

string

required

Unique identifier for the allocation investment.

Required string length: 1 - 64

Example:

"allctn-7mnn0-rltpq-9bvps60gjm09td0j"

walletId

string

required

Wallet id.

Required string length: 1 - 64

Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

protocol

enum<string>

required

The DeFi protocol used for allocation generation. Currently supports OFNS protocol

Available options:

0fns

amount

Native Asset · object

required

The total amount currently invested in this allocation.

Native Asset
EVM Fungible Token (ERC-20)

Show child attributes

amount.kind

enum<string>

required

Available options:

Native

amount.amount

string

required

amount.metadata

object

required

Show child attributes

amount.metadata.network

enum<string>

required

Available options:

Algorand,

AlgorandTestnet,

Aptos,

AptosTestnet,

ArbitrumOne,

ArbitrumSepolia,

ArcTestnet,

AvalancheC,

AvalancheCFuji,

BabylonGenesis,

BabylonTestnet5,

Base,

BaseSepolia,

Berachain,

BerachainBepolia,

Bitcoin,

BitcoinSignet,

BitcoinTestnet3,

BitcoinCash,

Bob,

BobSepolia,

Bsc,

BscTestnet,

Canton,

CantonTestnet,

Cardano,

CardanoPreprod,

Celo,

CeloAlfajores,

Codex,

CodexSepolia,

CosmosHub4,

CosmosIcsTestnet,

Dogecoin,

Ethereum,

EthereumClassic,

EthereumClassicMordor,

EthereumGoerli,

EthereumSepolia,

EthereumHolesky,

EthereumHoodi,

FantomOpera,

FantomTestnet,

FlareC,

FlareCCoston2,

FlowEvm,

FlowEvmTestnet,

Hedera,

HederaTestnet,

Ink,

InkSepolia,

InternetComputer,

Ion,

IonTestnet,

Iota,

IotaTestnet,

Kaspa,

Kusama,

KusamaAssetHub,

Litecoin,

Near,

NearTestnet,

Optimism,

OptimismSepolia,

Origyn,

Plasma,

PlasmaTestnet,

Plume,

PlumeSepolia,

Paseo,

PaseoAssetHub,

Polkadot,

PolkadotAssetHub,

Polygon,

PolygonAmoy,

Polymesh,

PolymeshTestnet,

Race,

RaceSepolia,

SeiAtlantic2,

SeiPacific1,

Solana,

SolanaDevnet,

Starknet,

StarknetSepolia,

Stellar,

StellarTestnet,

Sui,

SuiTestnet,

Tezos,

TezosGhostnet,

TempoAndantino,

Tsc,

TscTestnet1,

Ton,

TonTestnet,

Tron,

TronNile,

Westend,

WestendAssetHub,

XrpLedger,

XrpLedgerTestnet

amount.metadata.decimals

number

required

amount.metadata.name

string

amount.metadata.symbol

string

amount.metadata.tid

string

rewards

Native Asset · object

required

The total rewards earned so far in this allocation.

Native Asset
EVM Fungible Token (ERC-20)

Show child attributes

rewards.kind

enum<string>

required

Available options:

Native

rewards.amount

string

required

rewards.metadata

object

required

Show child attributes

rewards.metadata.network

enum<string>

required

Available options:

Algorand,

AlgorandTestnet,

Aptos,

AptosTestnet,

ArbitrumOne,

ArbitrumSepolia,

ArcTestnet,

AvalancheC,

AvalancheCFuji,

BabylonGenesis,

BabylonTestnet5,

Base,

BaseSepolia,

Berachain,

BerachainBepolia,

Bitcoin,

BitcoinSignet,

BitcoinTestnet3,

BitcoinCash,

Bob,

BobSepolia,

Bsc,

BscTestnet,

Canton,

CantonTestnet,

Cardano,

CardanoPreprod,

Celo,

CeloAlfajores,

Codex,

CodexSepolia,

CosmosHub4,

CosmosIcsTestnet,

Dogecoin,

Ethereum,

EthereumClassic,

EthereumClassicMordor,

EthereumGoerli,

EthereumSepolia,

EthereumHolesky,

EthereumHoodi,

FantomOpera,

FantomTestnet,

FlareC,

FlareCCoston2,

FlowEvm,

FlowEvmTestnet,

Hedera,

HederaTestnet,

Ink,

InkSepolia,

InternetComputer,

Ion,

IonTestnet,

Iota,

IotaTestnet,

Kaspa,

Kusama,

KusamaAssetHub,

Litecoin,

Near,

NearTestnet,

Optimism,

OptimismSepolia,

Origyn,

Plasma,

PlasmaTestnet,

Plume,

PlumeSepolia,

Paseo,

PaseoAssetHub,

Polkadot,

PolkadotAssetHub,

Polygon,

PolygonAmoy,

Polymesh,

PolymeshTestnet,

Race,

RaceSepolia,

SeiAtlantic2,

SeiPacific1,

Solana,

SolanaDevnet,

Starknet,

StarknetSepolia,

Stellar,

StellarTestnet,

Sui,

SuiTestnet,

Tezos,

TezosGhostnet,

TempoAndantino,

Tsc,

TscTestnet1,

Ton,

TonTestnet,

Tron,

TronNile,

Westend,

WestendAssetHub,

XrpLedger,

XrpLedgerTestnet

rewards.metadata.decimals

number

required

rewards.metadata.name

string

rewards.metadata.symbol

string

rewards.metadata.tid

string

dateCreated

string<date-time>

required

ISO 8601 date (must be UTC). ISO 8601 date. When the allocation was created.

Example:

"2023-04-14T20:41:28.715Z"

actions

object[]

required

Show child attributes

actions.id

string

required

Unique identifier for the allocation action.

Required string length: 1 - 64

Example:

"allctn-a-04p5n-gkkgd-5qk71nuev5n2ug1t"

actions.allocationId

string

required

Unique identifier for the allocation investment.

Required string length: 1 - 64

Example:

"allctn-7mnn0-rltpq-9bvps60gjm09td0j"

actions.kind

enum<string>

required

The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds.

Available options:

Deposit,

Withdraw

actions.status

enum<string>

required

Status of the allocation action. Once initiated, the status will be InProgress, after processing it will be Completed or Failed.

Available options:

PendingPolicyApproval,

InProgress,

Completed,

Failed,

Rejected

actions.requester

object

required

Show child attributes

actions.requester.userId

string

required

User (could be a service account) who requested the resource.

Required string length: 1 - 64

Example:

"us-6b58p-r53sr-rlrd3l5cj3uc4ome"

actions.requester.tokenId

string

Service Account token or Personal Access token used when requesting the resource.

Required string length: 1 - 64

Example:

"to-202a0-cdo33-o65mbt6q758lvvnt"

actions.requestBody

0fns Allocation Action Request · object

required

The full request used for initiating this allocation action.

0fns Allocation Action Request
0fns Allocation Request

Show child attributes

actions.requestBody.kind

enum<string>

required

The type of action being performed on the allocation investment: Deposit to add funds or Withdraw to remove funds.

Available options:

Deposit,

Withdraw

actions.requestBody.sourceAsset

EVM Fungible Token (ERC-20) · object

required

Show child attributes

actions.requestBody.sourceAsset.kind

enum<string>

required

Available options:

Erc20

actions.requestBody.sourceAsset.contract

string

required

actions.requestBody.sourceAsset.amount

string

required

actions.requestBody.targetAsset

EVM Fungible Token (ERC-20) · object

required

Show child attributes

actions.requestBody.targetAsset.kind

enum<string>

required

Available options:

Erc20

actions.requestBody.targetAsset.contract

string

required

actions.requestBody.targetAsset.amount

string

required

actions.requestBody.slippageBps

number

required

The slippage tolerance for this trade in basis point (BPS). Slippage tolerance defines the maximum price difference you're willing to accept during a trade from the estimated quote, ensuring you still receive at least a minimum number of tokens if the price shifts. One basis point equals one-hundredth of a percentage point, or 0.01%.

actions.requestBody.externalId

string

An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations.

actions.dateCreated

string<date-time>

required

ISO 8601 date (must be UTC). ISO 8601 date. When the allocation action was created.

Example:

"2023-04-14T20:41:28.715Z"

actions.externalId

string

An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations.

actions.failureReason

string

The failure reason, if any. Only present when status is Failed.

API Authorization

Identity & Access Management

Wallets & Transactions

Management

Webhooks

Authentication

Required Permissions

Authorizations

Path Parameters

Response

API Authorization

Identity & Access Management

Wallets & Transactions

Management

Webhooks

​Authentication

​Required Permissions

Authorizations

Path Parameters

Response

Authentication

Required Permissions