{ "openapi": "3.0.1", "info": { "title": "GBIF Biodiversity Scraper — Species & Occurrences", "description": "Search GBIF's global biodiversity database in bulk. Get species taxonomy (kingdom to genus, rank, status) or occurrence records (coordinates, country, date, basis of record). Filter occurrences by country, year and coordinates. Export to JSON, CSV or Excel.", "version": "1.0", "x-build-id": "6G8JTwH0TdV8dsWZL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~gbif-species-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-gbif-species-scraper", "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/hipersoft~gbif-species-scraper/runs": { "post": { "operationId": "runs-sync-hipersoft-gbif-species-scraper", "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/hipersoft~gbif-species-scraper/run-sync": { "post": { "operationId": "run-sync-hipersoft-gbif-species-scraper", "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", "properties": { "mode": { "title": "Mode", "enum": [ "species", "occurrences" ], "type": "string", "description": "What to search. \"species\" returns one row per taxon (scientific name, rank, full taxonomy, status). \"occurrences\" returns one row per recorded observation (coordinates, country, date, basis of record).", "default": "species" }, "query": { "title": "Search query", "type": "string", "description": "Free-text search term, typically a scientific or common name, e.g. \"Panthera leo\", \"oak\", \"Apis mellifera\". Leave empty to browse the full dataset (occurrences mode) filtered by the options below." }, "rank": { "title": "Taxonomic rank (species mode)", "enum": [ "", "KINGDOM", "PHYLUM", "CLASS", "ORDER", "FAMILY", "GENUS", "SPECIES", "SUBSPECIES", "VARIETY", "FORM" ], "type": "string", "description": "Species mode only: restrict results to a single taxonomic rank. Leave empty for all ranks.", "default": "" }, "country": { "title": "Country (occurrences mode)", "type": "string", "description": "Occurrences mode only: 2-letter ISO 3166-1 alpha-2 country code to filter records by where the observation was made, e.g. \"KE\" for Kenya, \"US\", \"SG\". Leave empty for all countries." }, "year": { "title": "Year (occurrences mode)", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "Occurrences mode only: filter records to a single observation year, e.g. 2013. Leave empty for all years." }, "hasCoordinate": { "title": "Only records with coordinates (occurrences mode)", "type": "boolean", "description": "Occurrences mode only: when enabled, return only observation records that carry decimal latitude/longitude coordinates.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum number of records to return across all pages.", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }