Getting Started

Welcome to Jua's data access documentation! We offer three convenient ways to access our weather forecast data:

1. REST API - Perfect for real-time programmatic access

2. Direct File Access - Ideal for accessing bulk data, including real-time and historical data

3. Platform UI - Easy-to-use interface for visualization and quick access to forecast data

This guide will help you get started. First, you'll need an API key to authenticate your requests.

Are you using Python? Check-out the documentation of our Python SDK

1. Create Your API Key

Head to the API Keys page to generate your credentials. You'll receive:

• An Access Key ID - Your public identifier

• A Secret Key - Keep this secure and never share it

Store these credentials safely - you'll need them for all data access.

2. Verify Your Access

Let's make sure everything is working with a quick test request:

Curl

curl -X GET 'https://api.jua.ai/v1/forecasting' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: example-key:example-secret'

Python

import requests

available_models = requests.get(
    "https://api.jua.ai/v1/forecasting",
    headers={"X-API-Key": f"{API_KEY_ID}:{API_SECRET}"}
).json()

print(available_models)

The above should print out a summary of the available forecasting models in JSON format.

3. Creating Reusable API Sessions in Python

For convenience when making multiple API requests, you can create a session that automatically includes your authentication headers. Here is how you might accomplish this when using the requests library in Python:

Python

import requests

session = requests.Session()
session.headers.update({"X-API-Key": f"{API_KEY_ID}:{API_SECRET}"})

# Note that you no longer need to pass in the headers on every request

available_models = session.get("https://api.jua.ai/v1/forecasting").json()

print(available_models)

4. Next Steps

Now that you have your API key set up, you can access our data in three ways. Choose the method that best fits your needs.

The API is great for real-time access to sparse sets of locations, while file access is ideal for bulk data retrieval and historical analysis, especially when retrieving contiguous regions of data. The platform interface provides an intuitive way to visualize and interact with forecast data without coding.

Access via API

For real-time programmatic access to our forecasts, check out our:

• Forecast API Guide - Learn how to fetch the latest weather forecasts

• Release Notes - Browse our API updates and new features

Access via File

For bulk retrieval of real-time and historical data:

• Forecast File Access - Access real-time and historic forecast files

• Historical Data Access - Query our large hindcast datasets

Access via Platform

For a visual experience with our forecast data:

• Platform Guide - Learn how to use our interactive web interface

• Visualization Tools - Explore our built-in data visualization features