TheHyWing Intelligence API

Your developer workspace

Use your TheHyWing login to verify your email, manage owned API keys and view usage. Test integrations with synthetic data before going live.

Customer portal Developer sandbox Reliability and incidents

Quickstart — 3 steps

Get your API key

Buy a plan below — your key is issued instantly after payment. Or email [email protected] for a free trial key. Keep it secret; send it in the X-API-Key header on every request.

Test your key

Confirm it works and see your plan + remaining calls:

curl https://api.thehywing.com/v1/partner/health \
  -H "X-API-Key: hyk_your_key_here"

# → { "ok": true, "tier": "starter", "remaining_this_month": 49872 }

Make your first real call

Get the climate-health risk for a location (Lagos here):

curl -X POST https://api.thehywing.com/v1/partner/climate-health/risk \
  -H "X-API-Key: hyk_your_key_here" -H "Content-Type: application/json" \
  -d '{ "latitude": 6.52, "longitude": 3.38 }'

That's it — you're live. Full endpoint reference is below.

What you can build

🌡️ Weather-health risk

Location → heat / cold / air-quality / wind / rain health risk with actionable guidance.

👷 Occupational safety

Occupation + PPE + weather → work-rest / heat-safety recommendation.

🦠 Outbreak / disease-signal feed

Active regional outbreak intelligence aggregated from public health sources.

🌾 Agri-climate

Growing-degree-days, evapotranspiration, crop heat-stress and livestock THI.

🗺️ Regional risk map (batch)

Score up to 25 coordinates in one call to build heat/air risk maps for a region.

Authentication

Every request needs your API key in the X-API-Key header. Keys are issued by our team — email [email protected]. All endpoints are under /v1/partner. Base URL: https://api.thehywing.com.

curl https://api.thehywing.com/v1/partner/health \
  -H "X-API-Key: hyk_your_key_here"

# → { "ok": true, "name": "Acme Insurance", "tier": "starter",
#     "rate_limit_per_min": 60, "monthly_quota": 50000,
#     "used_this_month": 128, "remaining_this_month": 49872 }

Rate limits are per key/minute and depend on your tier. Exceeding returns 429.

Plans & pricing

Each key has a monthly call quota and a per-minute rate limit. When you hit your monthly quota the API returns 429 until the next month or an upgrade. Check /v1/partner/health any time to see your usage and remaining calls.

Plan	Calls / month	Rate limit	Price
Trial	1,000	30/min	Free
Starter	50,000	60/min	₦25,000 / mo
Growth	200,000	200/min	₦75,000 / mo
Scale	1,000,000	600/min	₦250,000 / mo
Enterprise	Unlimited / custom	2,000/min+	Contact us

Buy a plan & get your key instantly

Pay securely with Paystack. Your API key is issued the moment payment confirms, valid for 31 days (renew by buying again).

Trial keys and Enterprise plans: email [email protected].

POST

/v1/partner/climate-health/risk

Health risk at a location. Optional vulnerability flags sharpen the thresholds.

curl -X POST https://api.thehywing.com/v1/partner/climate-health/risk \
  -H "X-API-Key: hyk_your_key_here" -H "Content-Type: application/json" \
  -d '{ "latitude": 6.52, "longitude": 3.38, "indoors": false, "respiratory_condition": true }'

# → {
#   "overall_level": "high",
#   "weather": { "temp_c": 38.0, "feels_like_c": 42.0, "humidity_pct": 70, "aqi": 3, ... },
#   "risks": [
#     { "hazard": "heat", "level": "high", "score": 72.0,
#       "reasoning": "feels-like 42°C above threshold",
#       "guidance": [ { "title": "...", "message": "...", "severity": "high" } ] }
#   ]
# }

POST

/v1/partner/occupational-safety

Work-rest / heat-safety recommendation for an occupation. occupation: farmer, rider, construction, guard, mechanic, general. ppe_type: none, light, heavy, encapsulated.

curl -X POST https://api.thehywing.com/v1/partner/occupational-safety \
  -H "X-API-Key: hyk_your_key_here" -H "Content-Type: application/json" \
  -d '{ "latitude": 9.08, "longitude": 7.4, "occupation": "construction", "ppe_type": "heavy" }'

# → { "score": 81.0, "level": "extreme", "recommendation": "Stop heavy work...", "weather": { ... } }

GET

/v1/partner/outbreaks?country=NG

Active outbreak / disease signals for a country (ISO alpha-2).

curl "https://api.thehywing.com/v1/partner/outbreaks?country=NG" \
  -H "X-API-Key: hyk_your_key_here"

# → { "country": "NG", "count": 2, "outbreaks": [
#   { "disease": "Cholera", "severity": "high", "affected_regions": ["NG"],
#     "source": "NCDC", "source_url": "...", "updated_at": "..." } ] }

POST

/v1/partner/agri-climate

Agronomic indices + optional crop heat-stress and livestock THI. crop: maize, rice, sorghum, cassava… livestock: cattle, goat, poultry…

curl -X POST https://api.thehywing.com/v1/partner/agri-climate \
  -H "X-API-Key: hyk_your_key_here" -H "Content-Type: application/json" \
  -d '{ "latitude": 10.5, "longitude": 7.4, "crop": "maize", "livestock": "cattle" }'

# → {
#   "indices": { "growing_degree_days": 12.5, "et0_mm_day": 5.1, "field_work_score": 78, ... },
#   "crop": { "crop": "Maize (Corn)", "status": "heat_stress", "note": "Above 35°C — yield loss likely" },
#   "livestock": { "animal": "Cattle", "thi": 84.2, "stress_level": "severe", "recommended_actions": [ ... ] }
# }

POST

/v1/partner/climate-health/risk/batch

Score up to 25 points for a regional risk map.

curl -X POST https://api.thehywing.com/v1/partner/climate-health/risk/batch \
  -H "X-API-Key: hyk_your_key_here" -H "Content-Type: application/json" \
  -d '{ "points": [
        { "latitude": 6.52, "longitude": 3.38, "label": "Lagos" },
        { "latitude": 9.08, "longitude": 7.40, "label": "Abuja" } ] }'

# → { "count": 2, "points": [ { "label": "Lagos", "overall_level": "high", "top_score": 72.0, ... } ] }

Request API access

Tell us your use case and expected volume and we'll issue a trial key.

Email [email protected]

Data is for risk-planning and decision support. Not a substitute for professional medical, agronomic, or emergency advice. Availability and coverage vary by region.