LogoLogo
AppAbout
  • 🙂Meet TokensFarm
  • Overview
    • 💻Our Products
    • ⚙️Features
    • 🚀Launch a Farm for Your Project
    • 🔏Using Gnosis Safe
  • For Developers
    • TokensFarmSDK
      • Getters
      • Setters
      • Parameters
      • ISDK.sol
      • Deposit
      • Withdraw
    • Integrate TokensFarm
      • Requesting Farm Data
      • Get Farm Address and Full Details
      • Monitoring a Farm's Status
      • Deposit into a farm
      • Withdraw from a farm
      • TokensFarm Contract Interface
      • How to integrate TokensFarmSDK
      • How to Embed TokensFarm
      • Getters of TokensFarm Contract
    • PerpetualTokensFarmSDK
      • Getters
      • Setters
      • Parameters
      • ISDK.sol
      • Deposit
      • Withdraw
    • PerpetualTokensFarm
      • Getters
      • Setters
      • Parameters
      • Deposit
      • Withdraw
  • About
    • 🔉Social Media
    • 🏢About DcentraLab
    • ❓FAQ
    • 📜Tokensfarm Audits
    • 📞Support
    • ⚖️Legal
Powered by GitBook
On this page
  • Get a List of Specific Farms with their Full Details
  • Filter by the token symbol to get full details for all corresponding farms
  • Get a Particular Farm's Object with Full Details
  • Get a specific farm's object with full details

Was this helpful?

  1. For Developers
  2. Integrate TokensFarm

Get Farm Address and Full Details

In order to participate in the farm and make a deposit, withdrawal, or any other functions, first we need to get the farm address by calling the TokensFarm API

PreviousRequesting Farm DataNextMonitoring a Farm's Status

Last updated 3 years ago

Was this helpful?

Get a List of Specific Farms with their Full Details

A farm's address will be included in the full farm details. In order to participate in a farm, you must first get the "full details" object, which will contain the farm's address. The address will allow you to interact with the contract.

In the response, you will find the farm address under the field "TokensFarm"

Filter by the token symbol to get full details for all corresponding farms

GET https://api.tokensfarm.com/farm/list?token=<token_symbol>&full=true

will response object with full details on the farm. "TokensFarm" parameter on response will contain the address of the farm

Path Parameters

Name
Type
Description

active

boolean

get only active/ended farms

sort

String

sort=apy -order by apy

sort=newest - order by date

sort=days_left - order by days left

page

Integer

get data by page number

farm_type

String

farm_type=LP,STAKING will return all the lp and staking farms

token

String

the symbol of the specific token for example: token=PORTX

page_size

Integer

the amount of farm objects in a page

full

boolean

if "true" will return a larger farm object with more data

view

String

example: tile

response example:

Get a Particular Farm's Object with Full Details

Get a specific farm's object with full details

GET https://api.tokensfarm.com/farm/config?symbol=HORD&type=LP&nonce=2

must be filtered by symbol, type and nonce

Path Parameters

Name
Type
Description

symbol

String

the symbol of the specific token for example: token=PORTX

type

String

farm_type=LP,STAKING will return all the lp and staking farms

nonce

Integer

nonce will be a count of the amount of time farms made for this token.

you can find a farm nonce with "Get farms list" API

response example:

https://api.tokensfarm.com/farm/list?token=DCD&full=true
https://api.tokensfarm.com/farm/config?symbol=HORD&type=LP&nonce=2