Quick Start

Create your first map animation in under 5 minutes.

1. Get Your API Key

Sign up at georender.io and grab your API key from the dashboard. Keys start with gr_live_ for production or gr_test_ for testing.

2. Make Your First Request

Using cURL

curl -X POST https://api.georender.io/v1/render \
  -H "Authorization: Bearer gr_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "waypoints": [
      { "lat": 29.9792, "lng": 32.5731, "label": "Suez Canal" },
      { "lat": 1.2644, "lng": 103.8176, "label": "Singapore" }
    ],
    "style": "maritime-dark",
    "duration": 12
  }'

Using Python

import georender

client = georender.Client(api_key="gr_live_xxxxxxxxxxxx")

job = client.render(
    waypoints=[
        {"lat": 29.9792, "lng": 32.5731, "label": "Suez Canal"},
        {"lat": 1.2644, "lng": 103.8176, "label": "Singapore"},
    ],
    style="maritime-dark",
    duration=12
)

# Wait for completion and get the video URL
video = job.wait()
print(video.url)
# https://cdn.georender.io/renders/job_8f3k2m9x.mp4

Using Node.js

import Georender from '@georender/sdk';

const client = new Georender({ apiKey: 'gr_live_xxxxxxxxxxxx' });

const job = await client.render({
  waypoints: [
    { lat: 29.9792, lng: 32.5731, label: 'Suez Canal' },
    { lat: 1.2644, lng: 103.8176, label: 'Singapore' },
  ],
  style: 'maritime-dark',
  duration: 12,
});

// Wait for completion
const video = await job.wait();
console.log(video.url);
// https://cdn.georender.io/renders/job_8f3k2m9x.mp4

3. Check Job Status

Renders are processed asynchronously. You can poll the status endpoint or use webhooks.

GET /v1/status/job_8f3k2m9x

{
  "job_id": "job_8f3k2m9x",
  "status": "complete",
  "video_url": "https://cdn.georender.io/renders/job_8f3k2m9x.mp4",
  "duration_seconds": 12,
  "resolution": "1920x1080",
  "file_size_bytes": 18432000,
  "expires_at": "2026-04-01T12:00:00Z"
}

Job status values:

4. Download Your Video

Once complete, the video_url is a direct link to your MP4 file. Videos are stored for 7 days (30 days for Studio plans).

Next Steps

• Render Modes - Explore route animation, region focus, multi-route, and country data
• Map Styles - Choose from 7 professional styles
• Camera & Animation - Customize camera movements
• Full API Reference - Complete parameter documentation