{ "openapi": "3.0.1", "info": { "title": "IFSCA & GST (CBIC) Circulars Monitor - RegPulse India", "description": "Monitor new IFSCA and GST (CBIC) circulars and notifications on a schedule. Filters, PDF text, revision alerts and RSS. RBI, SEBI and DGFT are opt-in only. Not affiliated with any regulator. Data from public notices; verify with the original document.", "version": "1.0", "x-build-id": "NyXXYPaB3tfBi3q4p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leons0016~india-regulatory-circulars-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leons0016-india-regulatory-circulars-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/leons0016~india-regulatory-circulars-monitor/runs": { "post": { "operationId": "runs-sync-leons0016-india-regulatory-circulars-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/leons0016~india-regulatory-circulars-monitor/run-sync": { "post": { "operationId": "run-sync-leons0016-india-regulatory-circulars-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": [ "regulators" ], "properties": { "regulators": { "title": "Regulators", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Pick the regulators to monitor, for example IFSCA and CBIC_GST. RBI, SEBI and DGFT are skipped unless 'Allow sources that ask for permission' is on. Free plan: only the first 2 monitored regulators are checked.", "items": { "type": "string", "enum": [ "RBI", "SEBI", "IRDAI", "PFRDA", "IFSCA", "MCA", "CBIC_GST", "DGFT" ], "enumTitles": [ "RBI (opt-in, see README)", "SEBI (opt-in, see README)", "IRDAI (not monitored)", "PFRDA (not monitored)", "IFSCA", "MCA (not monitored)", "CBIC (GST)", "DGFT (opt-in, see README)" ] }, "default": [ "IFSCA", "CBIC_GST" ] }, "documentTypes": { "title": "Document types", "uniqueItems": true, "type": "array", "description": "Press releases and orders are many; add them only if you need them. Example: [\"circular\", \"master_direction\"].", "items": { "type": "string", "enum": [ "circular", "notification", "master_direction", "press_release", "order", "public_notice", "trade_notice", "guideline", "consultation" ], "enumTitles": [ "Circular", "Notification", "Master direction", "Press release", "Order", "Public notice", "Trade notice", "Guideline", "Consultation paper" ] }, "default": [ "circular", "notification", "master_direction", "guideline", "public_notice", "trade_notice" ] }, "lookbackDays": { "title": "First run: look back", "minimum": 1, "maximum": 90, "type": "integer", "description": "On the first run of a regulator, items from the last N days are delivered (1 to 90, example 30 for a backfill). Later runs deliver only new items.", "default": 7 }, "keywordsAny": { "title": "Keywords (any)", "type": "array", "description": "Deliver if the title or text contains any of these, case-insensitive. Example: KYC, outsourcing. Empty means no keyword filter.", "default": [], "items": { "type": "string" } }, "keywordsAll": { "title": "Keywords (all)", "type": "array", "description": "Deliver only if all of these appear in the title or text. Example: digital lending, disclosure.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Never deliver items containing these. Example: penalty, compounding.", "default": [], "items": { "type": "string" } }, "regex": { "title": "Regular expression", "maxLength": 300, "type": "string", "description": "Advanced. Python regular expression applied to the title and text, at most 300 characters. Example: \\bUPI\\b.*\\blimit" }, "applicableTo": { "title": "Applicable to", "uniqueItems": true, "type": "array", "description": "Deliver items tagged for these entity types, for example NBFC. Tags come from text rules; check the tagEvidence field of each item.", "items": { "type": "string", "enum": [ "NBFC", "HFC", "BANK_SCHEDULED_COMMERCIAL", "BANK_COOPERATIVE", "SMALL_FINANCE_BANK", "PAYMENTS_BANK", "PAYMENT_AGGREGATOR", "PPI_ISSUER", "ARC", "AIF", "MUTUAL_FUND", "STOCKBROKER", "DEPOSITORY_PARTICIPANT", "INVESTMENT_ADVISER", "RESEARCH_ANALYST", "LISTED_ENTITY", "REIT_INVIT", "INSURER_LIFE", "INSURER_GENERAL", "INSURANCE_INTERMEDIARY", "PENSION_FUND", "IFSC_ENTITY", "COMPANY", "LLP", "GST_TAXPAYER", "EXPORTER_IMPORTER" ] }, "default": [] }, "matchMode": { "title": "Combine filters with", "enum": [ "and", "or" ], "type": "string", "description": "AND: an item must pass the keyword filters and the applicable-to filter. OR: either group is enough (only matters when both are set).", "default": "and" }, "includeFullText": { "title": "Include full text", "type": "boolean", "description": "Adds the extracted document text to each item (charged per item). Not available on the Apify free plan. RBI text is never delivered, and text of sources that ask for permission is your responsibility (see the README).", "default": false }, "maxTextChars": { "title": "Max text length", "minimum": 1000, "maximum": 2000000, "type": "integer", "description": "Longest text kept per item, in characters (1,000 to 2,000,000). Longer documents are cut and marked textTruncated.", "default": 200000 }, "includeHindi": { "title": "Include Hindi versions", "type": "boolean", "description": "Hindi documents are linked to the English item (hindiUrl). Switch on to deliver them as separate items too.", "default": false }, "maxResultsPerRun": { "title": "Max results per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The run stops delivering after this many items (1 to 10,000). The rest is delivered by the next run. Free plan: at most 10.", "default": 200 }, "webhookUrl": { "title": "Webhook URL", "maxLength": 2000, "type": "string", "description": "Optional. The OUTPUT JSON is posted here after each run. Example: https://example.com/hooks/regpulse" }, "slackWebhookUrl": { "title": "Slack incoming webhook", "type": "string", "description": "Optional. A short message with up to 10 new items is posted to this Slack incoming webhook URL." }, "stateKey": { "title": "State key", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string", "description": "Optional. Runs with the same key share what was already delivered. Letters, digits, dot, dash and underscore, at most 64. Example: compliance-team" }, "deliverRevisions": { "title": "Deliver revised documents", "type": "boolean", "description": "When the file or page of a known circular changes, deliver it again with changeType revised.", "default": true }, "perSourceTimeoutSecs": { "title": "Time limit per regulator", "minimum": 10, "maximum": 1800, "type": "integer", "description": "A regulator that takes longer is marked failed and the others continue (10 to 1,800 seconds).", "default": 180 }, "allowPermissionRequiredSources": { "title": "Allow sources that ask for permission (RBI, SEBI, DGFT)", "type": "boolean", "description": "Off by default. RBI's terms prohibit caching and framing of its site and its robots.txt refuses bots; SEBI's and DGFT's website policies ask for permission before their material is reproduced. Switch this on only if you accept responsibility for using the output within those terms (for example by obtaining permission before you republish it). The publisher has no permission from these regulators.", "default": false } } }, "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 } } } } } } } } } }