STAT-FASTAPI Umbra

An implementation of stapi-fastapi for Umbra Space proxying to the Canopy API.

Examples

Start the server locally

poetry run umbra

By default the environment is configured to use the Sandbox. If you want to switch to the live environment set the environment variable CANOPY_API_URL=https://api.canopy.umbra.space.

Ensure you've set the environment variable CANOPY_TOKEN=... with a valid token that matches whichever environment you've targeted with CANOPY_API_URL.

Get all products

curl http://127.0.0.1:8001/products

Search opportunities by product

Spotlight Image

If an opportunity request includes a time interval in the past, the archive will be checked for existing collects as opportunities. No authorization is required to search the public Umbra Archive.

If an opportunity request includes a time interval in the future, new feasibility opportunities will be provided via the Canopy API which requires authorization via a CANOPY_TOKEN envvar.

curl -H "Content-Type: application/json" \
-d '{
    "geometry": {
        "type": "Point",
        "coordinates": [-112.146,40.522]
    },
    "filter": {
        "op": "=",
        "args": [
        true,
        {
            "property": "umbra:open-data-catalog"
        }
        ]
    },
    "product_id": "umbra_spotlight",
    "datetime": "2024-08-01T00:00:00Z/2024-09-01T00:00:00Z"
}' -X POST http://127.0.0.1:8001/opportunities

Create an order from an opportunity

curl -H "Content-Type: application/json" \
-d '{
    "geometry": {
        "type": "Point",
        "coordinates": [
            -112.146,
            40.522
        ]
    },
    "datetime": "2024-10-14T05:48:03+00:00/2024-10-14T06:00:18+00:00",
    "product_id": "umbra_spotlight"
}' -X POST http://127.0.0.1:8001/orders

Retrieve an order by id

curl -X GET http://127.0.0.1:8001/orders/fe955a89-597f-463d-8668-49fc049ee4bb