API Documentation
The HICS data API is fully public and requires no authentication for read access. All readings include an automatic quality flag.
HICS API सार्वजनिक र प्रमाणीकरण-मुक्त छ। कुनै API key आवश्यक छैन। दर: १२०/मिनेट।
/api/v1/stations/
सबै सक्रिय र मर्मत स्टेसनहरूको सूची। ?output=geojson थपेर GeoJSON FeatureCollection पनि प्राप्त गर्न सकिन्छ।
| Field | Type | Description |
|---|---|---|
| station_id | string | Unique station identifier |
| name | string | Human-readable station name |
| latitude / longitude | float | Decimal degrees |
| altitude_m | float | Metres above sea level |
| status | string | active / maintenance |
| last_seen | datetime | Last telemetry timestamp (UTC) |
| latest.temperature_c | float | Most recent temperature (°C) |
/api/v1/data/compare/?stations=IESH-KMC-001,DLP-001
एकै अनुरोधमा धेरै स्टेसनहरूको समानान्तर टाइमसिरिज। उचाइ-ढाँचा तुलना चार्टहरूका लागि उपयुक्त।
| Param | Values | Default |
|---|---|---|
| stations | comma-separated station IDs (max 10) | required |
| param | temperature_c · humidity_rh · pressure_hpa · pm2_5 · pm10 · co2_ppm | temperature_c |
| hours | 1–720 | 24 |
| quality | ok | all flags |
/api/v1/data/latest/?station=IESH-KMC-001
कुनै स्टेसनको नवीनतम मापन।
quality_flag — ok | suspect | invalid.
स्वचालित सीमा-जाँच: suspect भनेको मान भौतिक सीमाभन्दा बाहिर छ।
/api/v1/data/historical/?station=IESH-KMC-001&hours=24
समय श्रृंखला। अधिकतम ७२० घण्टा (३० दिन)।
| Param | Default | Description |
|---|---|---|
| station | IESH-KMC-001 | Station ID |
| hours | 24 | Lookback window in hours. Clamped to [1, 720]. |
/api/v1/data/download/?station=IESH-KMC-001
सम्पूर्ण इतिहास CSV फाइल। CC BY 4.0 उद्धरण हेडर समावेश। धेरै स्टेसन: ?stations=IESH-KMC-001,DLP-001 — एउटै CSV मा सबै, station_id स्तम्भसहित।
timestamp_utc, temperature_c, humidity_rh, pressure_hpa, pm2_5_ugm3, pm10_ugm3, co2_ppm, quality_flag
| Param | उदाहरण | विवरण |
|---|---|---|
| from_date | 2026-01-01 | सुरु मिति (YYYY-MM-DD, समावेशी) |
| to_date | 2026-06-30 | अन्त मिति (YYYY-MM-DD, समावेशी) |
| quality | ok | ok राख्दा suspect र invalid मापन हटाउँछ |
उदाहरण: ?station=IESH-KMC-001&from_date=2026-01-01&to_date=2026-03-31&quality=ok
/api/v1/stats/
सम्पूर्ण प्लेटफर्मको समग्र तथ्याङ्क: स्टेसन संख्या, पढाइ गणना, गुणस्तर प्रतिशत, र डेटा दायरा।
| Field | Type | विवरण |
|---|---|---|
| stations.total | int | कुल स्टेसन (सबै स्थिति) |
| stations.active | int | सक्रिय स्टेसन |
| readings.total | int | कुल पढाइ सङ्ख्या |
| readings.ok | int | quality_flag=ok पढाइहरू |
| readings.ok_pct | float|null | ठीक पढाइको प्रतिशत (गणना नभएमा null) |
| readings.earliest | datetime | पहिलो मापन (UTC) |
| readings.latest | datetime | अन्तिम मापन (UTC) |
| generated_at | datetime | प्रतिक्रिया उत्पन्न समय (UTC) |
/api/v1/data/aggregate/?station=IESH-KMC-001&period=month
समयावधि अनुसार सांख्यिकीय एकत्रीकरण (mean/min/max)। शोध प्रकाशन, PANGAEA सबमिसन र प्रवृत्ति विश्लेषणका लागि।
| Param | Values | Default |
|---|---|---|
| station | station_id | IESH-KMC-001 |
| period | hour · day · week · month | day |
| from_date | YYYY-MM-DD | all |
| to_date | YYYY-MM-DD | all |
| quality | ok | all flags |
| output | csv | json |
/api/v1/health/
स्टेसन स्वास्थ्य जाँच। उपटाइम मनिटर र स्वचालित जाँचका लागि उपयुक्त। मानव-पठनीय सेवा स्थिति: /status/
/api/v1/notes/
प्रकाशित ल्याब नोटहरूको JSON सूची। फिल्टर: ?type=, ?programme=, ?from_date=। पृष्ठहरू: प्रति पृष्ठ २०।
/api/v1/publications/
HICS प्रकाशनहरूको JSON सूची। फिल्टर: ?pub_type=, ?year=। DOI, abstract, र linked authors सहित।
/publications/<id>/cite.ris
RIS ढाँचामा उद्धरण डाउनलोड (Zotero, Mendeley, RefWorks, EndNote का लागि)।
/embed/station/IESH-KMC-001/
तपाईंको वेबसाइटमा एम्बेड गर्न मिल्ने लाइभ स्टेसन विजेट। स्वचालित रूपमा हरेक ६० सेकेन्डमा अपडेट हुन्छ।
| Param | Values | Default |
|---|---|---|
| param | temperature_c · humidity_rh · pressure_hpa · pm2_5 · co2_ppm | temperature_c |
| theme | dark · light | dark |
| hours | 1–168 | 24 |
/api/v1/activity/
ल्याब नोट र प्रकाशनको एकीकृत कालानुक्रमिक फिड। ?limit=N (अधिकतम ५०) ले प्रविष्टि संख्या नियन्त्रण गर्छ।
/api/v1/search/?q=<query>
सबै HICS सामग्री (अनुसन्धान, ल्याब नोट, टोली, उपकरण, प्रकाशन) मा पूर्ण-पाठ खोज। अधिकतम २० परिणाम।
/api/v1/changelog/
API संस्करण इतिहास — प्रत्येक संस्करणमा के थपियो वा परिवर्तन भयो।
प्रत्येक मापनमा quality_flag स्वचालित रूपमा तोकिन्छ।
| Flag | अर्थ |
|---|---|
| ok | सबै मानहरू भौतिक सीमाभित्र। |
| suspect | एक वा बढी मानहरू भौतिक सीमाभन्दा बाहिर। सीमाहरू: temp −50..60°C, RH 0..100%, pressure 300..1100 hPa, PM2.5 0..1000 µg/m³। |
| invalid | अपरेटरद्वारा म्यानुअल रूपमा खारेज। |