{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0c102ce6-6f37-4748-b0bc-c054d99488b8","name":"API documentation","description":"# 📄 Introduction\n\n---\n\nThe Sunsethue API provides API products, tools, and resources that enable you to access and use Sunsethue's data products in your applications and projects.\n\n## **Getting started guide**\n\nSteps to start using the Sunsethue API:\n\n- Sign up for the API on [sunsethue.com/dev-api](https://sunsethue.com/dev-api)\n    \n- Generate an API key in the API portal [sunsethue.com/dev-api/portal](https://sunsethue.com/dev-api)\n    \n- Consult your daily request quota, you cannot go over the daily request quota on a free account. Be aware that the number of credits used differ per endpoint.\n    \n\n## Authentication\n\nThe Sunsethue API uses API keys for authentication. You can generate a Sunsthue API key in the [API portal](https://sunsethue.com/dev-api/portal).\n\nYou must include your API key in every request you make to the Sunsethue API. The key can be passed in two ways:\n\n- Pass the API key in the header of the HTTP request using the `x-api-key` property\n    \n- Pass the API key as an argument (`key={your_key}`) in the URL of the request\n    \n\n_Be careful with exposing the API key to the frontend of your application, as it can be accessed and stolen by malicious actors._\n\n**Generate a key**  \nIf you do not have an API key yet, you can click \"generate key\" to generate a random API key. Make sure to store this key securely as it cannot be viewed again. Every account is limited to one API key.\n\n**Delete a key**  \nTo delete your API key, click \"delete key\". This can only be done if you have an active API key. On deletion, the API key will stop working instantly.\n\n**Regenerating a key**  \nTo generate a new key, delete your existing key and generate a new key.\n\n**Usage**  \nTo evaluate your usage, you can go to the API portal where you can view your quota and usage for this day (since 0UTC). Paying users can see their usage for the past 30 days.\n\nAlternatively, you can use the `/usage` endpoint. This endpoint takes no arguments (besides your API key) and does not cost any credits. The response is formatted like this (where the usage and quota are expressed as number of credits):\n\n``` json\n{\n  \"daily_usage\": 140,\n  \"daily_quota\": 1000,\n  \"plan\": \"paying\",\n  \"time\": \"2026-06-12T19:11:48.963Z\"\n}\n\n ```\n\n### Error responses\n\nIf your request fails, an error response is returned. The returned object contains a `status` field with\n\n- `400`: user error\n    \n- `500`: server error\n    \n\nThe `code` field and `message` contain more information about the error. If you need help, please contact [tropoflow@gmail.com](https://mailto:tropoflow@gmail.com), and include your request URL and the error `code`.\n\nExample error response:\n\n``` json\n{\n  status: 400,\n  code: 204,\n  message: \"Exceeded daily quota\"\n}\n\n ```\n\n### **Need some help?**\n\nIn case of issues with the Sunsethue API, contact me at [tropoflow@gmail.com](https://mailto:tropoflow@gmail.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"39964523","team":16669807,"collectionId":"0c102ce6-6f37-4748-b0bc-c054d99488b8","publishedId":"2sAYBUDY4W","public":true,"publicUrl":"https://documenter-api.postman.tech/view/39964523/2sAYBUDY4W","privateUrl":"https://go.postman.co/documentation/39964523-0c102ce6-6f37-4748-b0bc-c054d99488b8","customColor":{"top-bar":"fffdff","right-sidebar":"303030","highlight":"ca6acd"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"The documentation for the Sunsethue API."},{"name":"title","value":"Sunsethue API Docs"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/6c78a407-259a-4580-ad78-9428a504d574/bG9nby1kYXJrLnBuZw==","colors":{"top-bar":"090109","right-sidebar":"303030","highlight":"923295"}},{"name":"light","logo":"https://content.pstmn.io/dc293141-704a-4ef9-894a-4763b03c4042/bG9nby5wbmc=","colors":{"top-bar":"fffdff","right-sidebar":"303030","highlight":"ca6acd"}}]}},"version":"8.11.11","publishDate":"2024-11-24T16:05:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Sunsethue API Docs","description":"The documentation for the Sunsethue API."},"logos":{"logoLight":"https://content.pstmn.io/dc293141-704a-4ef9-894a-4763b03c4042/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/6c78a407-259a-4580-ad78-9428a504d574/bG9nby1kYXJrLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d2a9dcb17669cdacf908ce1875c85573440509af33e88577107af880ff1967c2","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYBUDY4W"}