Tiles API 0.21.2

Tiles API provides access to weather map tiles for visualizing precipitation data. It supports standard XYZ tile formats compatible with popular mapping services like Mapbox and Google Maps. The API enables real-time and forecast precipitation visualization through both individual map tiles and complete map snapshots.

Servers

Description	URL
Production API server	https://api.rainbow.ai

Endpoints

GET /v1/snapshot

Map snapshot

Description

Returns the most recent weather map snapshot

Response 200 OK

application/json

{
    "snapshot": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "snapshot": {
            "type": "integer",
            "title": "Snapshot"
        }
    },
    "type": "object",
    "required": [
        "snapshot"
    ],
    "title": "MapSnapshot"
}

GET /v1/precip/{snapshot}/{forecast_time}/{zoom}/{tile_x}/{tile_y}

Precipitation map tile

Description

This endpoint provides precipitation map tiles in PNG format, designed for use with common mapping services.

Tiles are PNG image files optimized for web mapping applications. They are generated using the Web Mercator projection (EPSG:3857), ensuring compatibility with popular mapping SDKs, including: - Mapbox - Google Maps - Leaflet - OpenLayers - Cesium - and others

Tiles are requested based on the standard XYZ tile system, allowing seamless integration into existing mapping applications.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`color`	query	integer	0	No	Color palette: 0 - Rainbow, 1 - TWC
`coverage`	query	boolean	0	No	Flag to enable coverage mask: 0 - disable, 1 - enable
`forecast_time`	path	integer		No	Forecast offset in seconds. Must be >= 0 and in range [0, 14400], step 600
`snapshot`	path	integer		No	Snapshot of the weather map
`tile_x`	path	integer		No	X coordinate of a tile. In range [0; 2^zoom]
`tile_y`	path	integer		No	Y coordinate of a tile. In range [0; 2^zoom]
`zoom`	path	integer		No	Zoom level [0 - 7]

Response 200 OK

image/png

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "string",
    "format": "binary"
}

Response 400 Bad Request

application/json

{
    "message": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "message": {
            "title": "Message",
            "type": "string"
        }
    },
    "required": [
        "message"
    ],
    "title": "ResponseError",
    "type": "object"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas

HTTPValidationError

Name	Type
`detail`	Array<ValidationError>

MapSnapshot

Name	Type
`snapshot`	integer

ValidationError

Name	Type
`loc`	Array<>
`msg`	string
`type`	string