PixelGust

PixelGust API

Weather, climate, terrain, hazard, environment and soil data for any point or polygon. Documentation: https://pixelgust.com/docs

Maps & location#environment

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Weather, climate, terrain, hazard, environment and soil data for any point or polygon. Documentation: https://pixelgust.com/docs

Endpoints 15

Public API v1

  • GETCurrent weather conditions/weather?lat=0.0&lon=0.0Get current weather (nowcast) for a point. Returns temperature, humidity, precipitation, wind, pressure, cloud cover, and more.
  • GETWeather forecast/weather/forecast?lat=0.0&lon=0.0Get the daily weather forecast for a point. day is 0-based: day 0 is the first forecast day (the day after the GFS run date, UTC). forecast_dates in the…
  • GETHistorical weather averages/weather/historical?lat=0.0&lon=0.0Get historical ERA5 weather averages for a point. Optional month filter (1-12).
  • GETTerrain data/terrain?lat=0.0&lon=0.0Get elevation, slope, aspect, and TWI for a point.
  • GETHazard data/hazards?lat=0.0&lon=0.0Get flood risk (TWI) for a point. Soil erosion is withdrawn for now: soil_erosion_t_ha_yr is null, and soil_erosion_note says why.
  • GETEnvironment data/environment?lat=0.0&lon=0.0Get NDVI, evapotranspiration, and land cover for a point.
  • GETProximity data/proximity?lat=0.0&lon=0.0Straight-line distance in km from a point to the nearest coastline, highway (motorway or trunk road), airport (large or medium), major port, hospital or…
  • POSTPolygon zonal statistics/polygon/statsCompute weather, terrain, hazard, and environment statistics for a polygon area. Coordinates are [longitude, latitude] pairs. mode is nowcast, forecast or…
  • GETService health/healthLiveness check for the API. Needs no key and costs no quota.
  • GETCheck API usage/usageCheck your current daily API usage and tier limits.

Soil

  • GETSoil properties/soil?lat=0.0&lon=0.0SoilGrids 2.0 soil properties at a point (ISRIC - World Soil Information, CC BY 4.0): 250 m mean predictions of bulk density, cation exchange capacity, coarse…
  • GETSoilGrids-compatible point queryhttps://pixelgust.com/soilgrids/v2.0/properties/query?lon=0.0&lat=0.0ISRIC's SoilGrids REST API v2.0 request and answer format (properties/query) on PixelGust's copy of the SoilGrids 2.0 mean maps (ISRIC - World Soil…
  • GETSoilGrids-compatible point query, key in the pathhttps://pixelgust.com/k/:api_key/soilgrids/v2.0/properties/query?lon=0.0&lat=0.0The same query for tools that cannot send headers, such as R's soilDB, whose endpoint becomes…
  • GETLayer structure (not available)https://pixelgust.com/soilgrids/v2.0/properties/layersproperties/layers is not available on PixelGust. The layers it serves are listed at https://pixelgust.com/docs#soilgrids.
  • GETWRB classification (not available)https://pixelgust.com/soilgrids/v2.0/classification/queryPixelGust serves SoilGrids soil properties only. WRB classification is not available.

API details

Base URL
https://pixelgust.com/v1
Authentication
An API key in the X-API-Key header
Operations
15 operations on 15 pathsGET 14POST 1
Main resources
Public API v1 10Soil 5
Response formats
application/json text/plain
Description format
OpenAPI 3.1.0, API version 1.1.0

How to test the PixelGust API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PixelGust API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Current weather conditions” (GET /weather?lat=0.0&lon=0.0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PixelGust API?

Weather, climate, terrain, hazard, environment and soil data for any point or polygon. Documentation: https://pixelgust.com/docs It is listed under Maps & location and has 15 endpoints.

Who publishes the PixelGust API?

It is listed from PixelGust's public API description (an OpenAPI document), not published by PixelGust on Swastik Codes. Anyone who controls pixelgust.com can claim the profile by adding a DNS TXT record.

What is the base URL of the PixelGust API?

Requests go to https://pixelgust.com/v1. Endpoint paths are added to this base URL.

How do I authenticate with the PixelGust API?

With an API key in the X-API-Key header.

How many endpoints does the PixelGust API have?

15 operations on 15 paths (14 GET, 1 POST). The largest groups are Public API v1, Soil.

Is forking the PixelGust API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.