Public API Reference — Hantavirus
अवलोकन
Hantavirus.app प्रकोप डेटा तक प्रोग्रामेटिक पहुँच के लिए एक सार्वजनिक, केवल-पढ़ने योग्य API प्रदान करता है। API tRPC पर बनाया गया है और https://api.hantavir.us.com/api/trpc पर पहुँचा जा सकता है।
प्रमाणीकरण
सार्वजनिक API अप्रमाणित है। सभी पढ़ने की प्रक्रियाएँ API कुंजी के बिना उपलब्ध हैं।
दर सीमाएँ
- प्रति IP पते 60 अनुरोध प्रति मिनट
- प्रतिक्रियाओं में शामिल दर सीमा हेडर:
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset - सीमा से अधिक होने पर
429 Too Many Requestsलौटता है
tRPC राउटर
| राउटर | मुख्य प्रक्रियाएँ | कैश TTL |
|---|---|---|
outbreak.* | getCurrent, getBySlug, list, getRiskLevel | 30s |
cases.* | getCounts, getTimeSeries | 30s |
regions.* | list, byCountry | 60s |
news.* | list, getById | कोई नहीं |
timeline.* | list | 60s (पहला पृष्ठ) |
faqs.* | list | कोई नहीं |
advisories.* | list, byCountry | कोई नहीं |
ticker.* | list | 10s |
पूर्ण प्रक्रिया दस्तावेज़ीकरण आंतरिक API संदर्भ में उपलब्ध है।
REST एंडपॉइंट
सुविधा के लिए, हम REST रैपर भी प्रदान करते हैं:
| एंडपॉइंट | विधि | विवरण |
|---|---|---|
/v1/outbreak/:slug | GET | स्लग द्वारा प्रकोप हेडर प्राप्त करें |
/v1/outbreaks | GET | सभी सक्रिय प्रकोपों की सूची |
/v1/cases/:slug | GET | एक प्रकोप के लिए केस गणना प्राप्त करें |
सर्वर-सेंट इवेंट्स (SSE)
| स्ट्रीम | विवरण | इवेंट |
|---|---|---|
/sse/ticker | लाइव समाचार टिकर अपडेट | text, severity, link |
/sse/ships/:mmsi | जहाज स्थिति अपडेट | lat, lng, speed, heading |
उदाहरण: ticker SSE
const source = new EventSource('https://api.hantavir.us.com/sse/ticker');
source.onmessage = (e) => {
const data = JSON.parse(e.data);
console.log(data.text, data.severity);
};स्थानीय भाषा समर्थन
सभी स्थानीय-जागरूक प्रक्रियाएँ निम्न के माध्यम से भाषा स्वीकार करती हैं:
hv-localeकुकीAccept-Languageहेडर- डिफ़ॉल्ट:
en
समर्थित: en, ar (गल्फ खलीजी), fr
पूर्ण API विवरण के लिए, पूर्ण API दस्तावेज़ीकरण देखें।