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
  }
}
'
import requests

url = "https://api.getnimbus.io/v2/farming/{id}/simulate"

payload = {
"type": "Pools",
"data": {
"priceChangeA": 10,
"priceChangeB": 20,
"weightA": 50,
"weightB": 50,
"value": 100
}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'Pools',
data: {priceChangeA: 10, priceChangeB: 20, weightA: 50, weightB: 50, value: 100}
})
};

fetch('https://api.getnimbus.io/v2/farming/{id}/simulate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getnimbus.io/v2/farming/{id}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'Pools',
'data' => [
'priceChangeA' => 10,
'priceChangeB' => 20,
'weightA' => 50,
'weightB' => 50,
'value' => 100
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.getnimbus.io/v2/farming/{id}/simulate"

payload := strings.NewReader("{\n \"type\": \"Pools\",\n \"data\": {\n \"priceChangeA\": 10,\n \"priceChangeB\": 20,\n \"weightA\": 50,\n \"weightB\": 50,\n \"value\": 100\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getnimbus.io/v2/farming/{id}/simulate")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"Pools\",\n \"data\": {\n \"priceChangeA\": 10,\n \"priceChangeB\": 20,\n \"weightA\": 50,\n \"weightB\": 50,\n \"value\": 100\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getnimbus.io/v2/farming/{id}/simulate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"Pools\",\n \"data\": {\n \"priceChangeA\": 10,\n \"priceChangeB\": 20,\n \"weightA\": 50,\n \"weightB\": 50,\n \"value\": 100\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "data": [
      {
        "date": "2023-11-07T05:31:56Z",
        "value": 123
      }
    ],
    "il": 123,
    "ilAmount": 123
  }
}

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