Get Plants

Returns a list of plant-related risks based on location and selected IDs.

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.

Show child attributes

id · string

The unique identifier for the plant risk. Example: poison-ivy.

title · string

The human-readable title of the plant risk. Example: Poison Ivy.

status · enum

The status of this risk assessment:

• applicable: Risk is present and relevant for this location
• not_applicable: Risk is not present or relevant for this location
• unavailable: Risk data is unavailable for this location
• error: An error occurred while assessing this risk

score · number

A number from 0-3 representing the prevalence of this plant in the area:

• 0: None
• 1: Low
• 2: Medium
• 3: High

tips · array

A collection of 1-2 sentence strings with tips and recommendations.

summary · string

A 1-2 sentence summary of the tips and key information.

error · string

Error message describing what went wrong. Only present when status is error.

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_risk_fields · string

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

Response

200

application/json

A list of plant risks.

responseId · string<uuid>

A unique identifier for this response

risks · object[]

Show child attributes