Skip to content

README.md

Latest commit

 

History

History
46 lines (33 loc) · 1.38 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.38 KB

cropgraph-api

The first climate-aware planting calendar API. 5,006 crops across 14 categories. 1,004 companion relationships. 120 GDD models. 6 climate types. Free.

Powered by @cropgraph/core.

Endpoints

Method Path Description
GET /api/zone USDA hardiness zone, climate type, frost dates
GET /api/planting What to plant now at a given coordinate
GET /api/crop/:slug Full crop detail + companions + antagonists
GET /api/companions/:slug Companions and antagonists for a crop
GET /api/check Relationship between two crops
GET /api/plan Compatibility report for a bed of crops
GET /api/crops Filter and list crops
GET /api/search Fuzzy crop search

Full docs: /docs (rendered at /docs once deployed).

Local dev

npm install
npm run dev    # vercel dev serves at http://localhost:3000

Deploy

vercel link
vercel             # preview
vercel --prod      # production
vercel domains add api.cropgraph.com

Rate limits

  • 60 requests/minute per IP (no API key required).
  • Responses include X-RateLimit-Remaining.
  • 429 with Retry-After on exceed.

License

MIT. Data attributions: USDA Cooperative Extension, USDA-ARS, Xerces Society, PRISM 2023 Plant Hardiness Zone Map.