{ "openapi": "3.0.1", "info": { "title": "Carbon Credit Registry Monitor", "description": "Monitor Gold Standard and Verra VCS carbon credit projects, issuances, and retirements with normalized output and change detection.", "version": "0.3", "x-build-id": "K1NuSpfMXBDxbW7a6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stevennguyen~carbon-registry-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stevennguyen-carbon-registry-monitor", "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/stevennguyen~carbon-registry-monitor/runs": { "post": { "operationId": "runs-sync-stevennguyen-carbon-registry-monitor", "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/stevennguyen~carbon-registry-monitor/run-sync": { "post": { "operationId": "run-sync-stevennguyen-carbon-registry-monitor", "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": [ "registries", "recordTypes", "maxItemsPerRegistry" ], "properties": { "registries": { "title": "Registries", "type": "array", "description": "Which public registries to query.", "items": { "type": "string", "enum": [ "gold_standard", "verra_vcs" ], "enumTitles": [ "Gold Standard", "Verra VCS" ] }, "default": [ "gold_standard", "verra_vcs" ] }, "recordTypes": { "title": "Record types", "type": "array", "description": "Which records to monitor. Projects are registry project records. Issuances and retirements are credit blocks / VCU asset records where available.", "items": { "type": "string", "enum": [ "projects", "issuances", "retirements" ], "enumTitles": [ "Projects", "Credit issuances", "Credit retirements" ] }, "default": [ "projects" ] }, "maxItemsPerRegistry": { "title": "Max items per registry / record type", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum matching records to output per registry and record type.", "default": 100 }, "countries": { "title": "Countries filter", "type": "string", "description": "Optional comma-separated country names, e.g. India, Brazil, Kenya." }, "statuses": { "title": "Statuses filter", "type": "string", "description": "Optional comma-separated statuses, e.g. ISSUED, RETIRED, LISTED, Under validation." }, "projectTypes": { "title": "Project type / methodology filter", "type": "string", "description": "Optional comma-separated terms matched against project type and methodology." }, "searchTerms": { "title": "Search terms", "type": "string", "description": "Optional comma-separated terms matched against project names, IDs, proponents/developers, serials, retirement fields, countries, descriptions, and methodologies. Required for Verra issuance/retirement event queries to avoid a slow unfiltered registry query." }, "onlyChanges": { "title": "Only emit changed records", "type": "boolean", "description": "When enabled, skip unchanged records. New, updated, and missing records are still emitted.", "default": true }, "emitUnchanged": { "title": "Emit unchanged records", "type": "boolean", "description": "Emit unchanged records too. Useful for first-run exports and debugging.", "default": false }, "compareWithPreviousRun": { "title": "Compare with previous run", "type": "boolean", "description": "Store fingerprints in the default key-value store and mark records as new, updated, unchanged, or missing_from_current_run.", "default": true }, "stateKey": { "title": "State key", "type": "string", "description": "Key-value store key used to persist run state. Change this to keep separate monitors for separate filters.", "default": "CARBON_REGISTRY_MONITOR_STATE" } } }, "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 } } } } } } } } } }