Authentication

API keys

Every call to the API needs a key. Keys are free, allow 5,000 requests per day, and let us tell you if something you depend on is about to change.

Getting a key

Register for an account, sign in, and open API keys in your dashboard. Creating a key shows it once. We store only a hash of it, so it cannot be shown again. If you lose it, revoke it and create another.

Every key begins narc_live_.

Sending a key

Either header works. Pick one.

X-API-Key header

The key on its own: X-API-Key: narc_live_…

Authorization header

Scheme and key: Authorization: Api-Key narc_live_…

Limits

Access	Limit	Who
Key	5,000 requests per day	Any registered account. Counted per key.
Partner	Unmetered	Set by NARC for government and research systems.

Over the limit you get 429 Too Many Requests. Wait for the window to pass rather than retrying immediately; retries still count.

Keeping a key safe

A key identifies your account, so treat it like a password: keep it on your server, in an environment variable, out of version control.

Don’t put a key in a web page

Anything in browser JavaScript is readable by anyone who opens the page. Call the API from your backend and pass the result on to your pages.

Revoking

Revoke a key from your dashboard and it stops working on the next request. Revoking is immediate and cannot be undone; create a new key and update your application.

Request

curl -G https://badebikesh.com.np/soil/api/soildata \
  -H "X-API-Key: $NARC_API_KEY" \
  -d lat=28.5737 \
  -d lon=80.8068

import os, requests

res = requests.get(
    "https://badebikesh.com.np/soil/api/soildata",
    headers={"X-API-Key": os.environ["NARC_API_KEY"]},
    params={"lat": 28.5737, "lon": 80.8068},
    timeout=10,
)
res.raise_for_status()
print(res.json()["ph"])

// Server side only. Never ship a key to the browser.
const res = await fetch(
  "https://badebikesh.com.np/soil/api/soildata?lat=28.5737&lon=80.8068",
  { headers: { "X-API-Key": process.env.NARC_API_KEY } }
);
const data = await res.json();

Response

{
  "detail": "This API needs an API key. Create one free at /dashboard/api-keys/ and send it as the X-API-Key header."
}

{
  "detail": "Invalid or revoked API key. Check the key, or create a new one in your dashboard."
}

{
  "detail": "Request was throttled. Expected available in 3600 seconds."
}