Docs
View as Markdown

sunrisesunset.day

stable Standard

Sunrise, sunset, solar noon, day length and twilights for a coordinate and date.

GET /v1/sunrisesunset/day

What you get#

One Sunrisesunset record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
latstringyes(required)Latitude in decimal degrees (-90..90)max 10 chars; must match -?(?:[0-8]?\d(?:\.\d{1,6})?|90(?:\.0{1,6})?); trimmed
lonstringyes(required)Longitude in decimal degrees (-180..180)max 11 chars; must match -?(?:1[0-7]\d(?:\.\d{1,6})?|\d{1,2}(?:\.\d{1,6})?|180(?:\.0{1,6})?); trimmed
datestringnotodayDate YYYY-MM-DD or todaymax 10 chars; must match \d{4}-\d{2}-\d{2}|today; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/sunrisesunset/day?lat=36.72&lon=-4.42&date=2024-06-21" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Sunrisesunset response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "ext": {
      "sunrise": "2024-06-21T04:57:49Z",
      "sunset": "2024-06-21T19:41:23Z",
      "dayLengthSeconds": 53014,
      "civilTwilightBegin": "2024-06-21T04:28:39Z",
      "civilTwilightEnd": "2024-06-21T20:10:34Z",
      "nauticalTwilightBegin": "2024-06-21T03:50:24Z",
      "nauticalTwilightEnd": "2024-06-21T20:48:49Z",
      "astronomicalTwilightBegin": "2024-06-21T03:07:29Z",
      "astronomicalTwilightEnd": "2024-06-21T21:31:43Z"
    },
    "entity": {
      "date": "2024-06-21T12:19:36Z"
    }
  },
  "metadata": {
    "platform": "sunrisesunset",
    "endpoint": "day",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
sunriseext.sunrisetoIsoDate
sunsetext.sunsettoIsoDate
solar_noonentity.datetoIsoDate
day_lengthext.dayLengthSecondstoNumber
civil_twilight_beginext.civilTwilightBegintoIsoDate
civil_twilight_endext.civilTwilightEndtoIsoDate
nautical_twilight_beginext.nauticalTwilightBegintoIsoDate
nautical_twilight_endext.nauticalTwilightEndtoIsoDate
astronomical_twilight_beginext.astronomicalTwilightBegintoIsoDate
astronomical_twilight_endext.astronomicalTwilightEndtoIsoDate

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).