{
  "openapi": "3.0.1",
  "info": {
    "title": "Global Forest Watch & Resource Watch Dataset Explorer",
    "description": "Browse the shared environmental dataset catalog behind Global Forest Watch, Resource Watch, Aqueduct, PREP, Forest Atlas and Open Data. Search by keyword and filter by source application, with provider and tag metadata per dataset.",
    "version": "1.0",
    "x-build-id": "8jsiaCpSGlc3NeBKT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vexaloom-labs~global-forest-watch-and-resource-watch-dataset/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vexaloom-labs-global-forest-watch-and-resource-watch-dataset",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/vexaloom-labs~global-forest-watch-and-resource-watch-dataset/runs": {
      "post": {
        "operationId": "runs-sync-vexaloom-labs-global-forest-watch-and-resource-watch-dataset",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/vexaloom-labs~global-forest-watch-and-resource-watch-dataset/run-sync": {
      "post": {
        "operationId": "run-sync-vexaloom-labs-global-forest-watch-and-resource-watch-dataset",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "datasets",
              "gfwDatasets",
              "datasetDetails",
              "datasetFields",
              "alerts",
              "statistics"
            ],
            "type": "string",
            "description": "Choose what to fetch. Catalog modes need no keys; alert modes use the public GFW Data API alert summary tables.",
            "default": "datasets"
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Free-text filter for catalog modes. Every word must appear in the name, description, tags, version or ID."
          },
          "application": {
            "title": "Application",
            "enum": [
              "",
              "gfw",
              "rw",
              "prep",
              "aqueduct",
              "forest-atlas",
              "open-data"
            ],
            "type": "string",
            "description": "Filter the Resource Watch catalog by source application. In GFW catalog mode it matches dataset tags, names and IDs.",
            "default": ""
          },
          "provider": {
            "title": "Provider",
            "enum": [
              "",
              "cartodb",
              "gfw",
              "gee",
              "featureservice",
              "csv",
              "json",
              "tsv",
              "wms",
              "vector",
              "rest",
              "bigquery",
              "rasdaman",
              "nexgddp",
              "loca",
              "arcgis"
            ],
            "type": "string",
            "description": "Filter Resource Watch catalog datasets by data provider.",
            "default": ""
          },
          "connectorType": {
            "title": "Connector type",
            "enum": [
              "",
              "rest",
              "document",
              "wms",
              "vector",
              "bigquery",
              "rasdaman",
              "nexgddp",
              "loca"
            ],
            "type": "string",
            "description": "Filter Resource Watch catalog datasets by connector type.",
            "default": ""
          },
          "datasetIds": {
            "title": "Dataset IDs, slugs or API URLs",
            "type": "array",
            "description": "Dataset references for datasetDetails. Accepts Resource Watch UUIDs, GFW Data API slugs and dataset API URLs.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "dataset": {
            "title": "GFW dataset slug",
            "type": "string",
            "description": "GFW Data API dataset slug used by datasetFields (for example umd_tree_cover_loss, gfw_integrated_alerts).",
            "default": "umd_tree_cover_loss"
          },
          "version": {
            "title": "Dataset version",
            "type": "string",
            "description": "GFW dataset version for datasetFields. Use latest or a version such as v1.9.1.",
            "default": "latest"
          },
          "area": {
            "title": "Area (ISO3, admin code, geostore or lat,lng)",
            "type": "string",
            "description": "Alerts and statistics area: ISO3 country code (BRA), ISO3:ADM1 (BRA:15), ISO3:ADM1:ADM2 (BRA:15:139), a Resource Watch geostore ID, or a latitude,longitude pair (for example -7.1,-54.9)."
          },
          "alertSystem": {
            "title": "Alert system",
            "enum": [
              "glad",
              "integrated"
            ],
            "type": "string",
            "description": "Alert layer used by alerts and statistics. Integrated alerts are newer; GLAD coverage on the public tables extends through 2021 for most countries.",
            "default": "glad"
          },
          "polygon": {
            "title": "Custom GeoJSON polygon",
            "type": "string",
            "description": "Optional GeoJSON Geometry, Feature or FeatureCollection. Overrides Area and is converted to a geostore automatically."
          },
          "radiusKm": {
            "title": "Point radius (km)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Radius used to build an area when Area is a latitude,longitude pair.",
            "default": 5
          },
          "startDate": {
            "title": "Start date",
            "type": "string",
            "description": "Alert period start in YYYY-MM-DD format.",
            "default": "2020-01-01"
          },
          "endDate": {
            "title": "End date",
            "type": "string",
            "description": "Alert period end in YYYY-MM-DD format.",
            "default": "2021-12-31"
          },
          "aggregateBy": {
            "title": "Group statistics by",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "type": "string",
            "description": "Time bucket used by statistics mode.",
            "default": "month"
          },
          "gladConfirmOnly": {
            "title": "Confirmed alerts only",
            "type": "boolean",
            "description": "Keep only alerts with confidence 3 or higher.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum records",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum records to return (1-1000). For statistics this caps the number of time buckets.",
            "default": 20
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}