Search / list species | Tree-Nation API Documentation

{
  "result": [
    {
      "id": 48,
      "name": "Teak",
      "project_id": 3,
      "life_time_CO2": 1.1,
      "stock": 1,
      "price": 1.1,
      "common_names": "string",
      "family": "string",
      "particularities": "string",
      "planter_likes": 1,
      "height": "string",
      "average_natural_life_span": 1,
      "co2_offset": 1.1,
      "co2_offset_period": "string",
      "image": "string",
      "category": {
        "id": 1,
        "name": "string"
      },
      "foliage_type": {
        "id": 1,
        "name": "string"
      },
      "origin_type": {
        "id": 1,
        "name": "string"
      },
      "price_per_tonne": 1.1
    }
  ],
  "meta": {
    "total": 1,
    "perPage": 1,
    "currentPage": 1
  }
}

Returns paginated species from affiliated projects. Only complete species with stock > 0 are returned.

Query parameters

idintegerOptional

Filter by exact species ID.

namestringOptional

Filter by name (LIKE match).

project_idintegerOptional

Filter by project ID.

pricedoubleOptional

Filter by exact price.

price_per_tonnedoubleOptional

Filter by exact price per tonne.

life_time_CO2doubleOptional

Filter by exact lifetime CO₂ value.

stockintegerOptional

Filter by exact stock level.

common_namesstringOptional

Filter by common names (LIKE match).

conservation_statusstringOptional

Filter by conservation status.

particularitiesstringOptional

Filter by particularities (LIKE match).

planter_likesintegerOptional

Filter by planter likes count.

origin_typestringOptional

Filter by origin type.

invasive_typestringOptional

Filter by invasive type.

categorystringOptional

Filter by category name.

usesstringOptional

Filter by uses (LIKE match).

limitintegerOptional

Maximum number of results per page.

offsetintegerOptional

Number of results to skip (for pagination).

order_byenumOptional

Field to sort results by.

Allowed values:

orderenumOptional

Sort direction.

Allowed values:

Response

Paginated species list.

resultlist of objects

metaobject