{
"garden_bed": [
"Tomato"
],
"best_companions": [
{
"name": "Asparagus",
"helps": [
"Basil",
"Calendula",
"Cilantro",
"Dill",
"Marigold",
"Oregano",
"Parsley",
"Petunia",
"Tomato"
],
"helped_by": [
"Basil",
"Lettuce",
"Petunia",
"Tomato"
],
"help_to_repel": [],
"avoid": [
"Broccoli",
"Garlic",
"Onion",
"Potato"
]
},
{
"name": "Basil",
"helps": [
"Asparagus",
"Lettuce",
"Oregano",
"Pepper",
"Tomato"
],
"helped_by": [
"Asparagus",
"Broccoli",
"Brussels Sprout",
"Lettuce",
"Pepper",
"Potato",
"Tomato"
],
"help_to_repel": [
"Aphid",
"Fly",
"Mosquito",
"Tomato Hornworm"
],
"avoid": [
"Rue",
"Sage",
"Thyme"
]
},
{
"name": "Bean",
"helps": [
"Beet",
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Carrot",
"Catnip",
"Cauliflower",
"Celery",
"Corn",
"Cucumber",
"Eggplant",
"Kale",
"Marigold",
"Nasturtium",
"Pea",
"Potato",
"Radish",
"Rosemary",
"Squash",
"Strawberry",
"Summer Savory",
"Sunflower",
"Tomato"
],
"helped_by": [
"Beet",
"Brussels Sprout",
"Cabbage",
"Carrot",
"Cauliflower",
"Celery",
"Corn",
"Cucumber",
"Eggplant",
"Kale",
"Larkspur",
"Lettuce",
"Nasturtium",
"Pea",
"Pepper",
"Potato",
"Pumpkin",
"Radish",
"Spinach",
"Squash",
"Strawberry",
"Swiss Chard"
],
"help_to_repel": [],
"avoid": [
"Beet",
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Chive",
"Fennel",
"Garlic",
"Gladiolus",
"Kohlrabi",
"Leek",
"Onion",
"Pepper",
"Shallot"
]
},
{
"name": "Bee Balm",
"helps": [
"Tomato"
],
"helped_by": [],
"help_to_repel": [],
"avoid": []
},
{
"name": "Carrot",
"helps": [
"Bean",
"Chive",
"Leek",
"Lettuce",
"Onion",
"Pea",
"Pepper",
"Radish",
"Rosemary",
"Sage",
"Tomato"
],
"helped_by": [
"Bean",
"Brussels Sprout",
"Garlic",
"Leek",
"Lettuce",
"Onion",
"Pea",
"Pepper",
"Radish",
"Tomato"
],
"help_to_repel": [],
"avoid": [
"Celery",
"Dill",
"Parsnip",
"Potato"
]
},
{
"name": "Celery",
"helps": [
"Bean",
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Cauliflower",
"Kale",
"Kohlrabi",
"Leek",
"Onion",
"Tomato"
],
"helped_by": [
"Bean",
"Broccoli",
"Cabbage",
"Cauliflower",
"Kale",
"Leek",
"Pea",
"Spinach",
"Tomato"
],
"help_to_repel": [],
"avoid": [
"Carrot",
"Corn",
"Lettuce",
"Parsnip",
"Potato"
]
},
{
"name": "Garlic",
"helps": [
"Beet",
"Broccoli",
"Cabbage",
"Carrot",
"Cauliflower",
"Dill",
"Eggplant",
"Kohlrabi",
"Lettuce",
"Pepper",
"Potato",
"Rose",
"Spinach",
"Strawberry",
"Tomato"
],
"helped_by": [
"Beet",
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Kale",
"Lettuce",
"Marigold",
"Pansy",
"Parsnip",
"Pepper",
"Potato",
"Rose",
"Strawberry",
"Tomato"
],
"help_to_repel": [
"Aphid",
"Beetle",
"Root Maggot"
],
"avoid": [
"Asparagus",
"Bean",
"Parsley",
"Pea",
"Sage"
]
},
{
"name": "Lettuce",
"helps": [
"Asparagus",
"Basil",
"Bean",
"Beet",
"Broccoli",
"Brussels Sprout",
"Carrot",
"Chive",
"Corn",
"Cucumber",
"Eggplant",
"Garlic",
"Mint",
"Onion",
"Pea",
"Radish",
"Spinach",
"Strawberry",
"Tomato"
],
"helped_by": [
"Alyssum",
"Basil",
"Beet",
"Broccoli",
"Carrot",
"Cucumber",
"Garlic",
"Kale",
"Lupin",
"Onion",
"Pea",
"Pepper",
"Phacelia",
"Potato",
"Radish",
"Spinach",
"Strawberry",
"Tomato"
],
"help_to_repel": [],
"avoid": [
"Cabbage",
"Celery",
"Parsley",
"Parsnip"
]
},
{
"name": "Marigold",
"helps": [
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Cauliflower",
"Chive",
"Cucumber",
"Garlic",
"Kale",
"Kohlrabi",
"Leek",
"Melon",
"Onion",
"Pepper",
"Potato",
"Pumpkin",
"Rose",
"Shallot",
"Squash",
"Tomato",
"Zucchini"
],
"helped_by": [
"Asparagus",
"Bean",
"Broccoli",
"Cucumber",
"Eggplant",
"Potato",
"Pumpkin",
"Rose",
"Squash",
"Tomato"
],
"help_to_repel": [
"Aphid",
"Beet Leafhopper",
"Beetle",
"Cabbage Root Fly",
"Cucumber Beetle",
"Onion Fly",
"Root-Knot Nematode",
"Slug",
"Snail",
"Squash Bug",
"Whitefly"
],
"avoid": []
},
{
"name": "Nasturtium",
"helps": [
"Apple",
"Bean",
"Broccoli",
"Brussels Sprout",
"Cabbage",
"Cauliflower",
"Cucumber",
"Grape",
"Kale",
"Kohlrabi",
"Radish",
"Raspberry",
"Squash",
"Tomato"
],
"helped_by": [
"Bean",
"Broccoli",
"Brussels Sprout"
]
}
],
"_note": "Response truncated for documentation purposes"
}
curl --location --request POST 'https://zylalabs.com/api/13645/plant+pair+api/30945/find+companion+plants' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"garden_bed": [
"Tomato"
]
}'
{
"compatible": true,
"garden_bed": [
"string",
"string"
]
}
curl --location --request POST 'https://zylalabs.com/api/13645/plant+pair+api/30946/check+garden+bed+compatibility?extensive=true' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"garden_bed": [
"Tomato"
]
}'
{
"status": "ok"
}
curl --location --request GET 'https://zylalabs.com/api/13645/plant+pair+api/30947/health+check' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plant Pair API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Highly detailed Companion Planting catalog online accessible over API
The POST Find companion plants endpoint returns lists of compatible plants for a specified garden bed, including best companions and possible plants. The POST Check garden bed compatibility endpoint returns a boolean indicating if the specified plants can share a bed. The GET Health check endpoint returns a simple status message indicating the service's availability.
Key fields in the POST Find companion plants response include "garden_bed," "best_companions," and "possible_to_plant." For the POST Check garden bed compatibility, the key field is "compatible." The GET Health check response contains the "status" field.
The response data is structured in JSON format. For companion plants, it includes arrays for "best_companions" and "possible_to_plant," each containing objects with plant names and their compatibility details. The compatibility check returns a simple boolean value, while the health check returns a status message.
The POST Find companion plants and POST Check garden bed compatibility endpoints require a "garden_bed" parameter containing one or more plant names. The "extensive" parameter can be used to modify the response for more detailed results. Invalid or fewer than two names will result in a 400 error.
The POST Find companion plants endpoint provides information on compatible plants, including those that help or are helped by others. The POST Check garden bed compatibility endpoint indicates whether specified plants can coexist. The GET Health check endpoint confirms the API's operational status.
Data accuracy is maintained through a mapping of common and cultivar names to catalog plants, ensuring consistent identification. The API also handles unknown names and provides approximate matches, helping users find relevant plants even if they input slightly incorrect names.
Typical use cases include gardeners seeking to optimize plant arrangements for better growth and pest control, as well as hobbyists wanting to explore plant compatibility. Users can also utilize the health check to ensure the API is operational before making requests.
If the garden_bed parameter is empty or contains unknown names, the API returns a 400 error. Users should ensure valid plant names are provided. For partial results, such as when some plants are compatible and others are not, the API will still return the compatible plants, allowing users to adjust their selections accordingly.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund