OpenWeatherMap OCaml
You can use the OpenWeatherMap API in OCaml using CoHTTP.
How to use the OpenWeatherMap API in OCaml (OCaml Example)
1. Sign up for a Free RapidAPI User Account
From any page on the RapidAPI Marketplace, click “Sign Up” and register for a free account.
2. Navigate the OpenWeatherMap API page
Get to the OpenWeatherMap API Page by clicking here or searching for it in the RapidAPI marketplace search bar.
3. Subscribe to the API
Next, click on the API’s Pricing Tab and select a plan to subscribe to. The OpenWeatherMap API has 2 pricing plans on RapidAPI:
- Basic – OpenWeatherMap’s free plan. $0.00/month with a 100 request/day hard limit. Rate limited at 10 requests/minute.
- Pro – $10/month that offers unlimited API requests. Rate limited at 100 requests/minute.
4. Test an OpenWeatherMap API Endpoint
After subscribing to a pricing plan, head back to the endpoints page and choose an endpoint, fill out the required parameters, and click “Test Endpoint”.
If done correctly, on the right side of the API console, you should see a response like this:
5. Copy the OCaml (CoHTTP) Code Snippet and add it to your application!
Now that you have successfully tested that the API works, click on the Code Snippet dropdown and select one of the following:
- OCaml –> CoHTTP
You’ll see something similar to this:
NSURLSession
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://community-open-weather-map.p.rapidapi.com/weather?q=London%252Cuk" in let headers = Header.add_list (Header.init ()) [ ("x-rapidapi-host", "community-open-weather-map.p.rapidapi.com"); ("x-rapidapi-key", "[your rapidapi key]"); ] in Client.call ~headers `GET uri >>= fun (res, body_stream) -> (* Do stuff with the result *)
Modify as needed and drop it into your application.
Voila, you’re done!
What data is available with the OpenWeatherMap API?
The OMW API has 4 endpoints available on RapidAPI:
- GET Current Weather Data
- GET Call 16 day / daily forecast data
- GET Search Weather Data
- GET 5 day / 3 hour forecast data
GET Current Weather Data
Description: Using this kind of requests you can get weather data in any location on the earth. The current weather data are updated online based on data from more than 40,000 weather stations.
Example request:
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://community-open-weather-map.p.rapidapi.com/weather?q=London%252Cuk" in let headers = Header.add_list (Header.init ()) [ ("x-rapidapi-host", "community-open-weather-map.p.rapidapi.com"); ("x-rapidapi-key", "[your rapidapi key]"); ] in Client.call ~headers `GET uri >>= fun (res, body_stream) -> (* Do stuff with the result *)
GET Call 16 day / daily forecast data
Description: 16-day forecasts are available for any location or city. Forecasts include daily weather and available in JSON or XML format. It is only available for all paid accounts.
Example request:
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://community-open-weather-map.p.rapidapi.com/forecast/daily?q=san%20francisco%252Cus" in let headers = Header.add_list (Header.init ()) [ ("x-rapidapi-host", "community-open-weather-map.p.rapidapi.com"); ("x-rapidapi-key", "[your rapidapi key]"); ] in Client.call ~headers `GET uri >>= fun (res, body_stream) -> (* Do stuff with the result *)
GET Search Weather Data
Description: By city name. Input the city name or its part and get the list of the most proper cities in the world. Example – Lon or Lond or London. The more precise city name you put the more precise list you will get. To make it more precise put the city’s name or its part, comma, the name of the county or 2-letter country code. You will get all the proper cities in the chosen county. The order is important – the first is city name then a comma then the county. Example – Lon, UK or Lon, GB or London, GB or Lon, England. By geographic coordinates.
Example request:
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://community-open-weather-map.p.rapidapi.com/find?units=imperial%252C%20metric&q=london" in let headers = Header.add_list (Header.init ()) [ ("x-rapidapi-host", "community-open-weather-map.p.rapidapi.com"); ("x-rapidapi-key", "[your rapidapi key]"); ] in Client.call ~headers `GET uri >>= fun (res, body_stream) -> (* Do stuff with the result *)
GET 5 day / 3 hour forecast data
Description: A 5-day forecast is available for any location or city. It includes weather data every 3 hours. The forecast is available in JSON or XML format.
Example request:
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://community-open-weather-map.p.rapidapi.com/forecast?q=san%20francisco%252Cus" in let headers = Header.add_list (Header.init ()) [ ("x-rapidapi-host", "community-open-weather-map.p.rapidapi.com"); ("x-rapidapi-key", "[your rapidapi key]"); ] in Client.call ~headers `GET uri >>= fun (res, body_stream) -> (* Do stuff with the result *)