Proprietary weather data and forecasting tools for understanding the present and preparing for a future of rapidly chainging climate.
\n\nContact Support: clientsuccess@climavision.com
\nThe status API is designed to be called from a server rather than multiple client applications directly, the data is updated as new sweeps are made available, a minimum of 30 seconds. There is rate limiting applied to this endpoint to prevent accidental overuse.
\nTo use this API, first call the Create Token endpoint to receive a token, which is then to be attached to each request in the Authorization header as a Bearer token. To get the status of a radar, simply call the Radar Status endpoint with the site code in the path, and reference the Site State field.
\nTo use the Radar Status API, you will first need to authenticate and retrieve a token.
\nThe API requires that you authenticate first using your issued Customer Id and Api Key. To do this you must submit a POST request to 'https://clientapi.climavision.com/auth/token' with a JSON body as below containing your credentials, please note the { } bracket symbols represent a variable for you to replace, the actual values shouldn't be surrounded by brackets:
\ncurl --location --request POST 'https://clientapi.climavision.com/auth/token' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"clientId\": \"{Client Id}\",\n \"key\": \"{API Key}\"\n}'\n\nOnce you have a bearer token, you can issue requests to any of the other endpoints within the Radar Status API. You will see each of the below requests have an Authorization header with a value of 'Bearer '. To use the API you need to insert your token after the word Bearer as below:
\n'Authorization': 'Bearer {Bearer Token}'
This endpoint provides a bearer token that must be added into the other requests to interact with the API. To retrieve the bearer token, POST the provided username and password to this endpoint.
\nThe token is valid for a 12-hour period, once it expires, this endpoint will need to be called again to obtain a new token.
\n","urlObject":{"protocol":"https","path":["auth","token"],"host":["clientapi","climavision","com"],"query":[],"variable":[]}},"response":[{"id":"b5cd7eb7-4c19-4b7b-9cd0-653ea8853cdb","name":"Create Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{client-id}\",\r\n \"key\": \"{API Key}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://clientapi.climavision.com/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1339"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599,\n \"ext_expires_in\": 3599,\n \"access_token\": \"{token}\"\n}"}],"_postman_id":"8d874d50-4034-40ab-906d-7bdd97298443"},{"name":"Radar Status","id":"34fdda01-15ec-4d2b-8f1d-2520414831c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {token}","type":"text"}],"url":"https://clientapi.climavision.com/maintenance/status/v018","description":"Once you have a token, requests can be issued to the status endpoint. The main part of this API is the Status section which denotes the active or maintenance state of the radar. It also outlines a lot of statistics around the most recent file seen, details of the peak latency seen, and future maintenance events.
\nThe most important field below is the Site Status field:
\nThe format of the below fields follow is as follows:
\nField Name: Example Data - Field description.
Site Information:
\nClimavision - Identifies the group the site belongs to (Climavision or NEXRAD).v018 - Unique identifier for the site.Climavision - St. Francisville, LA - User-friendly name of the site.4 - Number of products associated with the site.23.44 seconds - Average latency across all products at the site.Peak Latency: Details about the highest recorded latency for any product:
\n1 - Elevation level where the peak latency occurred.4 - Number of products with the same peak latency.February 6, 2024, 7:01 PM PST - Date and time the peak latency data was recorded.v01820240206_190029_01_V06.ar2v - Name of the file containing the peak latency data.February 6, 2024, 7:00 PM PST - Date and time the radial scan for peak latency was performed.v018 - Site identifier.1402 - Volume Coverage Pattern number.February 6, 2024, 7:00 PM PST - Date and time the volume scan for peak latency was performed.30.93 seconds - Highest recorded latency for any product.Metadata: General information about the latest available data:
\nSummary: Overview of the site's current status:
\nFebruary 6, 2024, 7:30 PM PST - Date and time the latest data file was created.0 - Number of planned future maintenance events.February 6, 2024, 7:29 PM PST - Date and time the latest data was collected.