{ "openapi": "3.0.1", "info": { "title": "GBIF Scraper", "description": "Scrape GBIF (Global Biodiversity Information Facility), 2.7B+ biodiversity occurrence records and 10M+ species. Search species taxonomy, browse occurrence records, explore contributing datasets, or fetch species details with vernacular names.", "version": "1.0", "x-build-id": "1lZFZCfP0JPiwlIGR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~gbif-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-gbif-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/crawlerbros~gbif-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-gbif-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/crawlerbros~gbif-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-gbif-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "searchSpecies", "searchOccurrences", "searchDatasets", "bySpeciesKey" ], "type": "string", "description": "What to fetch from GBIF.", "default": "searchSpecies" }, "query": { "title": "Search query", "type": "string", "description": "Scientific or common name to search (mode=searchSpecies, searchOccurrences, searchDatasets). E.g. `Panthera leo`, `lion`, `oak`.", "default": "Panthera leo" }, "rank": { "title": "Taxonomic rank", "enum": [ "", "KINGDOM", "PHYLUM", "CLASS", "ORDER", "FAMILY", "GENUS", "SPECIES", "SUBSPECIES", "VARIETY", "FORM" ], "type": "string", "description": "Filter species results by taxonomic rank (mode=searchSpecies).", "default": "" }, "kingdom": { "title": "Kingdom", "enum": [ "", "ANIMALIA", "PLANTAE", "FUNGI", "CHROMISTA", "PROTOZOA", "ARCHAEA", "BACTERIA", "VIRUSES" ], "type": "string", "description": "Filter species results by kingdom (mode=searchSpecies).", "default": "" }, "taxonKey": { "title": "Taxon key (mode=searchOccurrences)", "minimum": 1, "maximum": 999999999, "type": "integer", "description": "GBIF taxon key to filter occurrence records (mode=searchOccurrences). Obtain from a searchSpecies run." }, "country": { "title": "Country code (mode=searchOccurrences)", "type": "string", "description": "ISO 3166-1 alpha-2 country code to filter occurrences, e.g. `US`, `GB`, `DE`, `ZA`. (mode=searchOccurrences)" }, "fromYear": { "title": "From year (mode=searchOccurrences)", "minimum": 1600, "maximum": 2100, "type": "integer", "description": "Filter occurrences observed on or after this year (mode=searchOccurrences)." }, "toYear": { "title": "To year (mode=searchOccurrences)", "minimum": 1600, "maximum": 2100, "type": "integer", "description": "Filter occurrences observed on or before this year (mode=searchOccurrences)." }, "basisOfRecord": { "title": "Basis of record (mode=searchOccurrences)", "enum": [ "", "HUMAN_OBSERVATION", "MACHINE_OBSERVATION", "MATERIAL_SAMPLE", "PRESERVED_SPECIMEN", "FOSSIL_SPECIMEN", "LIVING_SPECIMEN", "LITERATURE", "UNKNOWN" ], "type": "string", "description": "How the occurrence was recorded (mode=searchOccurrences).", "default": "" }, "datasetType": { "title": "Dataset type (mode=searchDatasets)", "enum": [ "", "OCCURRENCE", "CHECKLIST", "METADATA", "SAMPLING_EVENT" ], "type": "string", "description": "Filter by dataset type (mode=searchDatasets).", "default": "" }, "speciesKey": { "title": "Species key (mode=bySpeciesKey)", "minimum": 1, "maximum": 999999999, "type": "integer", "description": "GBIF species/taxon key for detail lookup with vernacular names (mode=bySpeciesKey)." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records to return.", "default": 50 } } }, "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 } } } } } } } } } }