Allocations API

{
  "id": "allctn-6a3ku-bn8d7-8u5rs1oukojms7k8",
  "walletId": "wa-3l3cj-l8mq7-8q78f9nopq7f1qjv",
  "protocol": "0fns",
  "amount": {
    "kind": "Erc20",
    "contract": "0x0A7660979A67E4bC51E750C628C8479ff9F458aE",
    "amount": "1000000000",
    "metadata": {
      "network": "EthereumSepolia",
      "name": "0fns",
      "symbol": "0fnsSepolia",
      "decimals": 6,
      "tid": "erc20:0x0A7660979A67E4bC51E750C628C8479ff9F458aE"
    }
  },
  "rewards": {
    "kind": "Erc20",
    "contract": "0x0A7660979A67E4bC51E750C628C8479ff9F458aE",
    "amount": "5000000",
    "metadata": {
      "network": "EthereumSepolia",
      "name": "0fns",
      "symbol": "0fnsSepolia",
      "decimals": 6,
      "tid": "erc20:0x0A7660979A67E4bC51E750C628C9479ff9F458aE"
    }
  },
  "dateCreated": "2025-10-09T10:57:55.758Z"
}

Providers

Provider	Description	Supported chains
M0	Offers the `0fns` protocol, an extension to the M0 USD-based stablecoin $M that offers rewards to holders. With 0fns you can trade your USDC on Ethereum into 0fns and begin earning rewards right away.	Ethereum Mainnet, Ethereum Sepolia
Yield.xyz	Offers a set of DeFi vault strategies, each with its own APY. You deposit the vault’s underlying token and can withdraw it at any time.	Ethereum Mainnet, Base

Protocols

The protocol field of an allocation identifies the strategy it deposits into:

`protocol` value	Provider	Strategy	Deposit asset	Network
`0fns`	M0	0fns	USDC	Ethereum
`SkySusds`	Yield.xyz	Sky Savings Rate (sUSDS)	USDS	Ethereum
`GauntletUsdcPrime`	Yield.xyz	Gauntlet USDC Prime (gtUSDC)	USDC	Ethereum
`SteakhouseUsdt`	Yield.xyz	Steakhouse USDT (steakUSDT)	USDT	Ethereum
`GauntletUsdcPrimeBase`	Yield.xyz	Gauntlet USDC Prime (gtUSDCp)	USDC	Base
`SteakhouseUsdcBase`	Yield.xyz	Steakhouse USDC (steakUSDC)	USDC	Base
`SentoraPyusdMain`	Yield.xyz	Sentora PYUSD Main (senPYUSDMain)	PYUSD	Ethereum

Yield.xyz vaults are available on mainnet networks only. For a product-level overview, see Allocations.

Flow Overview

Create an Allocation position: Create a new allocation position by depositing/trading assets into the Allocations protocol.
Track Status: Monitor the Allocation position execution.
Increase/Decrease position: Add or remove assets from an existing Allocation position.

Allocation object

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

Pattern: ^allctn-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"allctn-7mnn0-rltpq-9bvps60gjm09td0j"

walletId

string

required

Wallet id.

Required string length: 1 - 64

Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

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

rewards

Native Asset · object

required

The total rewards earned so far in this allocation.

Native Asset
EVM Fungible Token (ERC-20)

Show child attributes

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"

Last modified on July 28, 2026

Payout action required

List Allocations

API Authorization

Identity & Access Management

Wallets & Transactions

Management

Webhooks

Providers

Protocols

Flow Overview

Allocation object

​Providers

​Protocols

​Flow Overview

​Allocation object

Providers

Protocols

Flow Overview

Allocation object