Skip to main content
POST
/
v2
/
farming
/
{id}
/
simulate
Simulate yield farming returns
curl --request POST \
  --url https://api.getnimbus.io/v2/farming/{id}/simulate \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "Pools",
  "data": {
    "priceChangeA": 10,
    "priceChangeB": 20,
    "weightA": 50,
    "weightB": 50,
    "value": 100
  }
}
'
{
  "data": {
    "data": [
      {
        "date": "2023-11-07T05:31:56Z",
        "value": 123
      }
    ],
    "il": 123,
    "ilAmount": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getnimbus.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

id
string
required

The ID of the vault to simulate

Query Parameters

chain
string
required

The chain of the vault

Body

application/json
type
enum<string>
required

The type of yield farming

Available options:
Pools,
Lending,
Staking
data
object
required

Response

Simulation results for different time periods

data
object