{ "openapi": "3.0.1", "info": { "title": "OBIS Ocean Biodiversity Information System Scraper", "description": "Scrape ocean species occurrences, checklists, datasets, and statistics from the OBIS (Ocean Biodiversity Information System) public API. Filter by scientific name, taxon, geometry (WKT polygon), date range, and more. No API key required.", "version": "0.0", "x-build-id": "qukKgnzjs4EqphbCy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~obis-ocean-biodiversity-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-obis-ocean-biodiversity-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/parseforge~obis-ocean-biodiversity-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-obis-ocean-biodiversity-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/parseforge~obis-ocean-biodiversity-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-obis-ocean-biodiversity-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": [ "occurrence", "checklist", "statistics", "dataset" ], "type": "string", "description": "What to fetch: occurrence records, taxonomic checklist, statistics, or dataset index.", "default": "occurrence" }, "scientificName": { "title": "Scientific Name", "type": "string", "description": "Filter by scientific name (e.g. Carcharodon carcharias, Delphinus delphis). Leave empty for all." }, "taxonId": { "title": "Taxon ID (AphiaID)", "minimum": 1, "type": "integer", "description": "WoRMS AphiaID to filter by. Overrides scientificName when set." }, "nodeId": { "title": "OBIS Node ID", "type": "string", "description": "Filter by an OBIS node UUID (regional data hub). Comma-separated for multiple. Find node IDs on the OBIS site." }, "flags": { "title": "Flags Filter", "type": "string", "description": "Comma-separated OBIS QC flags to require (e.g. NO_DEPTH,ON_LAND). Empty = no flag filter." }, "startDate": { "title": "Start Date", "type": "string", "description": "Earliest event date, format YYYY-MM-DD (e.g. 2020-01-01)." }, "endDate": { "title": "End Date", "type": "string", "description": "Latest event date, format YYYY-MM-DD (e.g. 2024-12-31)." }, "geometry": { "title": "Geometry (WKT)", "type": "string", "description": "WKT polygon to restrict occurrences (e.g. POLYGON((-10 30,-10 50,30 50,30 30,-10 30))). Leave empty for global." }, "depthMin": { "title": "Min Depth (m)", "minimum": 0, "type": "integer", "description": "Minimum sampling depth in meters. Leave empty for no minimum." }, "depthMax": { "title": "Max Depth (m)", "minimum": 0, "type": "integer", "description": "Maximum sampling depth in meters. Leave empty for no maximum." }, "compact": { "title": "Compact output", "type": "boolean", "description": "Drop low-value fields (flags, dropped, absence) for slimmer rows.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" } } }, "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 } } } } } } } } } }