GET
/
v1
/
risks
/
plants
cURL
curl --request GET \
  --url https://api.goes.health/v1/risks/plants
{
  "responseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "risks": [
    {
      "id": "poison-ivy",
      "title": "Poison Ivy",
      "status": "applicable",
      "score": 2,
      "summary": "<string>",
      "tips": [
        "<string>"
      ],
      "error": "<string>"
    }
  ]
}
Coming Soon — This endpoint is under development and will be available at a future date.
This endpoint allows you to check for plant-related health risks based on a specific location. You can check for all plant risks or specify particular ones.

​
Request

​
Headers

​
Authorization
string
required
Your API key for authentication. Format: Bearer YOUR_API_KEY

​
Query Parameters

​
location
string
required
The latitude and longitude for the location to check, formatted as {latitude},{longitude}.
​
ids
string
A comma-separated list of plant risk IDs to check. If you do not provide this, all plant risks will be checked. The available ids are:
  • poison-sumac
  • poison-oak
  • poison-ivy

​
Response

The response is a JSON object containing a responseId and a risks array. Each object in the array represents a specific plant risk and includes an id, a title, a score, and a list of tips.
​
responseId
string
A unique identifier for this response. Use this ID if submitting feedback about the response.
​
risks
array
An array of plant risk objects.

​
Example

​
Request

curl "http://api.goes.health/v1/risks/plants?ids=poison-ivy,poison-oak&location=34.0522,-118.2437" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "responseId": "123e4567-e89b-12d3-a456-426614174000",
  "risks": [
    {
      "id": "poison-ivy",
      "title": "Poison Ivy",
      "status": "applicable",
      "score": 2,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "poison-oak",
      "title": "Poison Oak",
      "status": "applicable",
      "score": 1,
      "summary": "...",
      "tips": [
        "..."
      ]
    }
  ]
}

Query Parameters

​
location
string
required

The latitude and longitude, formatted as {latitude},{longitude}.

​
ids
string

A comma-separated list of plant risk IDs.

​
exclude
string

Comma-separated list of sections to exclude from the response. Options: tips, summary, score

Response

200
application/json

A list of plant risks.

The response is of type object.