Phrases API - Getting Started

You’ll need an active Xweather API subscription and your application registered with the weather API in order to receive the required access ID and secret key.

Create an Xweather API account

Sign up for an Xweather Flex subscription . We offer a free developer account for you to give our weather API a test drive.

Create your API access keys

Log in to your account and find the Apps section to register your application for an API access key. Within the Apps section, click on New Application to register a new app. You will then be prompted to enter a project name and namespace. These can be updated at any time.

Review our API endpoints and actions

Find the endpoints and actions that provide you with the data you need in order to work with the weather API directly.

Check out our toolkits and SDKs

Our weather toolkits get you up and running with our Phrases API quickly.

Service domain updates: As of April 1, 2024, our API domain has changed to data.api.xweather.com. However, the previous api.aerisapi.com domain will continue to be supported.

Basic API Requests

Once you’ve signed up for the Xweather API and have an active client id and secret for your application, you’re ready to start creating some requests. The following are some very basic code samples for various programming languages to help you get started with the weather API:

PHP


<?php
// fetch Aeris API output as a string and decode into an object
$response = file_get_contents("https://data.api.xweather.com/observations/seattle,wa?client_id=CLIENT_ID&client_secret=CLIENT_SECRET");
$json = json_decode($response);
if ($json->success == true) {
   // create reference to our returned observation object
   $ob = $json->response->ob;
   echo sprintf("The current weather in Seattle is %s with a temperature of %d.", strtolower($ob->weather), $ob->tempF);
}
else {
   echo sprintf("An error occurred: %s", $json->error->description);
}
?>

Javascript


<script type="text/javascript" src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script type="text/javascript">
   jQuery(document).ready(function($) {
      $.ajax({
         url: "https://data.api.xweather.com/observations/seattle,wa?client_id=

Ruby


#!/usr/bin/env ruby
 
require 'rubygems'
require 'open-uri'
require 'json'
 
url = 'https://data.api.xweather.com/observations/seattle,wa?client_id=CLIENT_ID&client_secret=CLIENT_SECRET'
buffer = open(url, "UserAgent" => "Ruby-Wget").read
 
#convert JSON data into a hash
response = JSON.parse(buffer)
ob = response['response']['ob']
print "The current weather in Seattle is " + ob['weather'].downcase + ' with a temperature of ' + ob['tempF'].to_s() + "\n"

Python


import requests
 
url = 'https://data.api.xweather.com/observations/seattle,wa?client_id=CLIENT_ID&client_secret=CLIENT_SECRET'
response = requests.get(url)
 
if response.status_code == 200:
    data = response.json()
    if data['success']:
        ob = data['response']['ob']
        print("The current weather in Seattle is %s with a temperature of %d" % (ob['weather'].lower(), ob['tempF']))
    else:
        print("An error occurred: %s" % (data['error']['description']))
else:
    print("An error occurred while fetching data: HTTP status code %d" % response.status_code)