This document is intended for users who want to write applications that interact with our aviation weather data API.
It explains basic concepts of the API itself and provides an overview of the different functions that our API supports.
This documentation is structured first by a group of related functionality: Station, METAR, TAF, etc., and then by endpoint. Endpoints are a specific method within that API that performs one action and is located at a specific URL.
Each endpoint in this documentation is described using several parts:
All API endpoints require an API key which is unique for each user. Your specific API key can be found on your Account Settings page.
In order to use our services you must provided your API key as a Header Parameter with each request as shown in our examples.
If you are currently logged into our website, we have already included your API key in the examples. Otherwise just replace
YOUR_API_KEY with your actual API key.
Normally a JSON formatted response data is compressed in a single line standard format. However for human readability, you can specify a Querysting parameter which will return the JSON with indentation, line wraps and spacing. This is especially useful when viewing the response JSON using CURL on the commandline.
||Pretty print JSON response.||https://api.checkwx.com/station/kjfk?pretty=1|
All of our API Plans have different levels of daily request limits. Each API call you make to our services counts as one request, regardless of the number of parameters.
To illustrate this concept, see the examples below:
|Example Requests||Number of API Calls|
Should you exceed your daily request limit, the API service will block your incoming requests and return a "402 : Over Quota" response.
The daily rate limit counter will reset to zero at 00:00 UTC.
To prevent exceeding your request limit you should consider caching the responses:
To improve connections and experiences for all our users, we block some accounts when we see suspicious activity or other overloads on our system:
Users that excessively or persistently exceed their rate limits may have their accounts disabled.
There are also some good examples on Github for working with our API. One recommended repo is api.checkwx.com-examples.
YOUR_API_KEYwith your actual API key when copying an example.
|Example Parameter||Actual Usage|
Nathanael Nordentoft has written a public .NET/C# wrapper
The wrapper is written to give users three ways of communicating with our API:
Successful API requests are returned with a status code of 200.
If you receive a status code in the range of 400 to 450, please check the error section in the JSON response data for the exact error message and resolution.
|200||OK||Successful request and response|
|400||Bad Request||Malformed parameters or other bad request|
|401||Unauthorized||Your API key is invalid|
|402||Over quota||Over plan quota on this endpoint|
|404||Not found||The resource or endpoint does not exist|
|422||Validation error||A validation error occurred|
|50X||Internal Server Error||An error occurred with our API|