Requesting Farm Data

The Farm List is a list of objects that contain relevant data regarding all farms that exist in the TokensFarm ecosystem

API Calls for all Farms

Get all farms list

GET https://api.tokensfarm.com/farm/list

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

chain

String

the chain we want to look for farms at.

input options: ethereum/binance/polygon

{
  "farms": [
    {
      "farmLiquidity": 3632131.2221367313,
      "endTime": "2022-05-14T00:40:51+00:00",
      "banner": "https://s3.amazonaws.com/static.tokensfarm.com/copi/3s/2/banner.jpg",
      "active": true,
      "vestingType": null,
      "vestingDistributionPeriod": null,
      "farmLiquidityMax": 4890477.9825967625,
      "network": {
        "chainName": "binance",
        "factoryUpdatedGitTag": "2022-01-16T12:00:00+00:00",
        "chainId": "56",
        "factoryUpdatedAt": "2022-01-16T12:00:00+00:00",
        "factoryProxyAddress": "0x827ca5Bfe9b0c90F69A4abCe446F3bcD00D93AbB",
        "networkId": 56,
        "id": 3,
        "etherscanLink": "https://bscscan.com",
        "factoryGitTag": "master-v0.1.0",
        "networkName": "bsc-mainnet",
        "rpcUrl": "https://bsc-dataseed.binance.org"
      },
      "shareImage": "https://s3.amazonaws.com/static.tokensfarm.com/copi/3s/2/share_image.jpg",
      "symbol": "COPI",
      "vestingPortion": null,
      "logo": "https://s3.amazonaws.com/static.tokensfarm.com/copi/3s/2/logo.jpg",
      "id": 70,
      "nonce": "2",
      "startTime": "2022-02-10T16:57:23+00:00",
      "apy": 7.035855449421467,
      "websiteLink": "https://cornucopias.io",
      "projectName": "Cornucopias",
      "type": "STAKING"
    },
    {
      "farmLiquidity": 517847.4872704626,
      "endTime": "2022-02-27T04:15:29+00:00",
      "banner": "https://s3.amazonaws.com/static.tokensfarm.com/xcad/lp/1/banner.png",
      "active": false,
      "vestingType": null,
      "vestingDistributionPeriod": null,
      "farmLiquidityMax": 2502115.9966024337,
      "network": {
        "chainName": "binance",
        "factoryUpdatedGitTag": "2022-01-16T12:00:00+00:00",
        "chainId": "56",
        "factoryUpdatedAt": "2022-01-16T12:00:00+00:00",
        "factoryProxyAddress": "0x827ca5Bfe9b0c90F69A4abCe446F3bcD00D93AbB",
        "networkId": 56,
        "id": 3,
        "etherscanLink": "https://bscscan.com",
        "factoryGitTag": "master-v0.1.0",
        "networkName": "bsc-mainnet",
        "rpcUrl": "https://bsc-dataseed.binance.org"
      },
      "shareImage": "https://s3.amazonaws.com/static.tokensfarm.com/xcad/lp/1/share-image.png",
      "symbol": "XCAD",
      "vestingPortion": null,
      "logo": "https://s3.amazonaws.com/static.tokensfarm.com/xcad/lp/1/logo.svg",
      "id": 22,
      "nonce": "3",
      "startTime": "2021-11-18T14:30:09.229000+00:00",
      "apy": 1935.6152852425087,
      "websiteLink": "https://www.xcademytoken.com",
      "projectName": "XCAD",
      "type": "LP"
    },...
  ],
  "pages": {
    "previous_page": null,
    "next_page": 2,
    "has_previous": false,
    "has_next": true,
    "total_records": 72,
    "page_size": 2,
    "current_page": 1,
    "total_pages": 36
  }
}

Get active farms list

GET https://api.tokensfarm.com/farm/list?active=true

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

chain

String

the chain we want to look for farms at.

input options: ethereum/binance/polygon

Other Useful Examples

Active LP Farms (Only)

GET https://api.tokensfarm.com/farm/list?active=true&farm_type=LP

Filtered farms by: farm status = active ,farm type = LP

For only staking farms just use: farm_type=STAKING

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

chain

String

the chain we want to look for farms at.

input options: ethereum/binance/polygon

Get active LP and Staking Farms that are deployed on the Binance Chain

GET https://api.tokensfarm.com/farm/list?active=true&farm_type=LP,STAKING&chain=binance

Filtered farms by: farm status = active, farm type = LP or STAKING, deployed chain = BNB chain

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

chain

String

the chain we want to look for farms at.

the chain we want to look for farms at.

input options: ethereum/binance/polygon

Get farms whose reward tokens are DCD

GET https://api.tokensfarm.com/farm/list?token=DCD

Filtered farms by the reward token address

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

chain

String

the chain we want to look for farms at.

input options: ethereum/binance/polygon

Last updated

Was this helpful?