DEVELOPER API

Environmental data, programmatically.

Access Kashmir’s most comprehensive environmental dataset. Free for public data. Build dashboards, research tools, and applications that protect the environment.

QUICK START

Make your first request

BASE URL

https://api.terraflow.in/v1

AUTHENTICATION

Not required for public data

RESPONSE FORMAT

JSON (default), CSV, GeoJSON

terminal

curl https://api.terraflow.in/v1/reports?category=water&status=verified&limit=10

RATE LIMITS

FREE

100req/min

Public data, no key required

RESEARCHER

1,000req/min

API key for academic and NGO use

ENTERPRISE

Custom

Dedicated support, webhooks, SLA

ENDPOINT REFERENCE

All endpoints

Explore every available endpoint. Locked endpoints require a Bearer token.

Pollution reports submitted by citizens

AUTHENTICATION

Auth patterns

Public endpoints require no authentication. Protected endpoints (creating reports, events, food listings) need a JWT Bearer token.

PUBLIC ENDPOINTS

No auth required

All GET endpoints for reports, air quality, Dal Lake data, ward stats, and leaderboard are publicly accessible.

JWT BEARER TOKEN

For writes

POST endpoints require a JWT token in the Authorization header. Obtain tokens via the auth endpoints (OTP or email/password login).

API KEY

Higher rate limits

For research and enterprise use. Include it as X-API-Key header. Available for researchers, NGOs, and enterprise partners.

terminal

# Public (no auth)
curl https://api.terraflow.in/v1/reports

# Authenticated
curl -H "Authorization: Bearer <your-jwt-token>" \
     https://api.terraflow.in/v1/reports

# With API key (higher rate limits)
curl -H "X-API-Key: tf_live_abc123xyz" \
     https://api.terraflow.in/v1/reports

RESPONSE FORMAT

Consistent envelope

All responses follow a consistent envelope structure. List endpoints include pagination metadata.

SUCCESS RESPONSE

200 OK

json

{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20,
    "total_pages": 5
  }
}

ERROR RESPONSE

4xx / 5xx

json

{
  "error": "Validation failed",
  "code": "VALIDATION_ERROR",
  "details": [
    {
      "field": "category",
      "message": "must be one of: water, air, waste, encroachment, deforestation, wildlife"
    }
  ]
}

EXPORT FORMATS

.json

Default response format. All endpoints return JSON.

.csv

Append ?format=csv to any list endpoint for spreadsheet-compatible output.

.geojson

Append ?format=geojson for spatial data with coordinates and ward boundaries.

RATE LIMITING DETAIL

Redis sliding window

Response headers — Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.
Sliding window — Limits use a Redis-backed sliding window algorithm. Your request count decays smoothly rather than resetting at a fixed interval.
HTTP 429 — When the limit is exceeded, the API returns 429 with a Retry-After header indicating how many seconds to wait.

GET STARTED

Ready to build?

Get your API key for higher rate limits and start building applications with Kashmir’s environmental data.

Get API Key Browse Open Data →

TerraFlow

Auth patterns

Public endpoints require no authentication. Protected endpoints (creating reports, events, food listings) need a JWT Bearer token.

PUBLIC ENDPOINTS

No auth required

All GET endpoints for reports, air quality, Dal Lake data, ward stats, and leaderboard are publicly accessible.

JWT BEARER TOKEN

For writes

POST endpoints require a JWT token in the Authorization header. Obtain tokens via the auth endpoints (OTP or email/password login).

API KEY

Higher rate limits

For research and enterprise use. Include it as X-API-Key header. Available for researchers, NGOs, and enterprise partners.

terminal

# Public (no auth)
curl https://api.terraflow.in/v1/reports

# Authenticated
curl -H "Authorization: Bearer <your-jwt-token>" \
     https://api.terraflow.in/v1/reports

# With API key (higher rate limits)
curl -H "X-API-Key: tf_live_abc123xyz" \
     https://api.terraflow.in/v1/reports

Consistent envelope

All responses follow a consistent envelope structure. List endpoints include pagination metadata.

SUCCESS RESPONSE

200 OK

json

{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20,
    "total_pages": 5
  }
}

ERROR RESPONSE

4xx / 5xx

json

{
  "error": "Validation failed",
  "code": "VALIDATION_ERROR",
  "details": [
    {
      "field": "category",
      "message": "must be one of: water, air, waste, encroachment, deforestation, wildlife"
    }
  ]
}