{
  "openapi": "3.0.1",
  "info": {
    "title": "India Company Website Scraper - CIN, GSTIN & Grievance Officer",
    "description": "Indian company websites in, one row per company out: CIN (parsed: listed, type, state, year), GSTIN with its check character verified, legal name, registered office, grievance officer, nodal officer, company secretary, e-mails and phones, each with the page it came from.",
    "version": "0.1",
    "x-build-id": "kmr0z3RhIAETVx9Dk"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~in-cin-website-contact-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-in-cin-website-contact-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/scrapersdelight~in-cin-website-contact-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-in-cin-website-contact-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/scrapersdelight~in-cin-website-contact-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-in-cin-website-contact-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": {
          "domains": {
            "title": "Company websites",
            "type": "array",
            "description": "Domains or URLs, one per line: \"flipkart.com\", \"https://www.zerodha.com/\", or a page that carries the disclosure (\"https://acme.in/contact-us\"). Add \", CIN, company name\" to a line to check your own record against the site, e.g. \"giva.co, U51909KA2019PTC218533\".",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "The same as Company websites, as a URL list (lets Make, Zapier, n8n or a Google Sheet hand a list over natively).",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "domainsFileUrl": {
            "title": "Domain list file URL",
            "type": "string",
            "description": "A CSV, TXT, JSON or JSONL file at a public URL. A CSV with a \"website\" column (and optional \"cin\" / \"company name\" columns) is read by header, e.g. a CRM export."
          },
          "sourceDatasetId": {
            "title": "Read domains from a dataset",
            "type": "string",
            "description": "Enrich another Actor's output: the ID of an Apify dataset whose items carry a website / domain / url field (e.g. a Google Maps or IndiaMART run)."
          },
          "domainFieldName": {
            "title": "Domain field name",
            "type": "string",
            "description": "The field holding the website in that dataset or CSV (dot path allowed, e.g. \"company.website\"). Empty = website, domain, url, site, homepage are tried."
          },
          "requireCin": {
            "title": "Only rows with a CIN",
            "type": "boolean",
            "description": "Drop rows that carry only a GSTIN and no Corporate Identity Number.",
            "default": false
          },
          "requireGrievanceOfficer": {
            "title": "Only rows with a grievance officer",
            "type": "boolean",
            "description": "Keep a row only when the site names its grievance officer (name or e-mail).",
            "default": false
          },
          "requireContact": {
            "title": "Only rows with an e-mail or phone",
            "type": "boolean",
            "description": "Keep a row only when at least one e-mail address or phone number was found.",
            "default": false
          },
          "listingStatus": {
            "title": "Listed / unlisted",
            "enum": [
              "any",
              "listed",
              "unlisted"
            ],
            "type": "string",
            "description": "Filter on the listing flag that is the first character of the CIN. Rows without a CIN fail a listed / unlisted filter.",
            "default": "any"
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Keep only these CIN ownership types (characters 13-15 of the CIN). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "PTC",
                "PLC",
                "OPC",
                "GOI",
                "SGC",
                "FLC",
                "FTC",
                "NPL",
                "ULL",
                "ULT",
                "GAP",
                "GAT"
              ],
              "enumTitles": [
                "Private limited company (PTC)",
                "Public limited company (PLC)",
                "One person company (OPC)",
                "Union government company (GOI)",
                "State government company (SGC)",
                "Public company, foreign subsidiary (FLC)",
                "Private company, foreign subsidiary (FTC)",
                "Not-for-profit / Section 8 (NPL)",
                "Unlimited public (ULL)",
                "Unlimited private (ULT)",
                "Guarantee, public (GAP)",
                "Guarantee, private (GAT)"
              ]
            }
          },
          "cinStates": {
            "title": "Registrar (RoC) state codes",
            "type": "array",
            "description": "Keep only CINs registered under these state codes (characters 7-8), e.g. \"KA\", \"MH\", \"DL\", \"TN\". Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "minFieldsRequired": {
            "title": "Minimum filled fields",
            "minimum": 0,
            "maximum": 12,
            "type": "integer",
            "description": "Keep a row only when at least this many of the 12 value fields (CIN, legal name, GSTIN, three addresses, e-mail, phone, three officer blocks, FSSAI) are filled. 0 = no minimum.",
            "default": 0
          },
          "emailPolicy": {
            "title": "E-mail addresses",
            "enum": [
              "all",
              "role-only",
              "exclude-role"
            ],
            "type": "string",
            "description": "Which e-mail addresses go into email / emails. Officer e-mails stay inside their officer block either way.",
            "default": "all"
          },
          "maxPagesParsed": {
            "title": "Pages read per site",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "Besides the homepage. The disclosure sits on Corporate Information, Grievance, Contact, Investors, Terms or About pages; they are read in that order, one of each kind first.",
            "default": 6
          },
          "maxDiscoveryRequestsPerDomain": {
            "title": "Requests per site",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "Hard cap on page, sitemap and guessed-path requests per site after the homepage.",
            "default": 10
          },
          "discoveryChannels": {
            "title": "Where to look",
            "type": "array",
            "description": "The homepage is always read. Links come first; the other three are used for sites whose footer is rendered by JavaScript.",
            "items": {
              "type": "string",
              "enum": [
                "anchor",
                "scriptPaths",
                "sitemap",
                "pathGuess"
              ],
              "enumTitles": [
                "Footer and page links (ranked)",
                "Paths named in an app shell's scripts",
                "XML sitemap (page sitemaps only)",
                "Common Indian disclosure paths (app shells only)"
              ]
            },
            "default": [
              "anchor",
              "scriptPaths",
              "sitemap",
              "pathGuess"
            ]
          },
          "extractSocials": {
            "title": "Social profile links",
            "type": "boolean",
            "description": "Add the LinkedIn, Facebook, Instagram, X, YouTube links the pages print.",
            "default": true
          },
          "extractPolicyUrls": {
            "title": "Terms and privacy URLs",
            "type": "boolean",
            "description": "Add the URLs of the site's own Terms and Privacy pages.",
            "default": true
          },
          "skipDomains": {
            "title": "Skip these domains",
            "type": "array",
            "description": "Domains to leave out, e.g. ones already in your CRM.",
            "items": {
              "type": "string"
            }
          },
          "previousDatasetId": {
            "title": "Skip what a previous run delivered",
            "type": "string",
            "description": "Dataset ID of an earlier run of this Actor: its domains and CINs are skipped before any request."
          },
          "dedupeBy": {
            "title": "One row per",
            "enum": [
              "cin-then-domain",
              "domain",
              "none"
            ],
            "type": "string",
            "description": "Two sites of the same company (one CIN) give one row by default, so a group of brand sites is billed once.",
            "default": "cin-then-domain"
          },
          "maxItems": {
            "title": "Max results",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many billed rows. 0 = no cap. Sites that print no identifier are never counted or billed.",
            "default": 1000
          },
          "maxDomains": {
            "title": "Max sites to read",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Read at most this many sites from the input (useful for a first test on a large list). 0 = all.",
            "default": 0
          },
          "includeMissRows": {
            "title": "Include unbilled rows",
            "type": "boolean",
            "description": "Also output (free) a row for each site that gave no identifier, with the reason: blocked, unreachable, contact details only, only a third party's CIN, filtered out.",
            "default": false
          },
          "includeFieldSources": {
            "title": "Page each value came from",
            "type": "boolean",
            "description": "Add fieldSources: for every field, the URL of the page it was read from.",
            "default": true
          },
          "saveRawPages": {
            "title": "Save the pages read",
            "type": "boolean",
            "description": "Store every page the parser read, gzipped, in the run's key-value store (an audit trail).",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave off to read sites directly (the default). Your own proxy URLs are used for every request. An Apify proxy group chosen here is used only for sites that refuse the direct request, and only with the retry option below on.",
            "default": {
              "useApifyProxy": false
            }
          },
          "escalateToResidentialOnBlock": {
            "title": "Retry refused sites via an Indian residential IP",
            "type": "boolean",
            "description": "For sites that refuse a non-Indian IP or redirect to a foreign storefront (Akamai / Cloudflare walls). Homepage and one more page per site; capped per run.",
            "default": false
          },
          "escalateToUnblockerOnBlock": {
            "title": "Last resort: Apify Unblocker",
            "type": "boolean",
            "description": "For a homepage that still refuses after the residential retry (e.g. an AWS WAF JavaScript check). One request per site; capped per run.",
            "default": false
          },
          "proxyCountry": {
            "title": "Residential proxy country",
            "type": "string",
            "description": "Two-letter country of the residential retry. IN reaches the Indian storefront of geo-redirecting sites.",
            "default": "IN"
          },
          "requestConcurrency": {
            "title": "Parallel sites",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Sites read at the same time. Lowered automatically to what the run's memory can hold (about 100 MB per site).",
            "default": 8
          },
          "perDomainTimeoutSecs": {
            "title": "Time per site (seconds)",
            "minimum": 10,
            "maximum": 600,
            "type": "integer",
            "description": "A site that is still loading after this many seconds is finished with the pages already read.",
            "default": 75
          },
          "requestTimeoutSecs": {
            "title": "Time per request (seconds)",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "A single page that takes longer is skipped.",
            "default": 25
          },
          "followWwwAndRootVariants": {
            "title": "Try www. / bare host",
            "type": "boolean",
            "description": "When \"acme.in\" fails, try \"www.acme.in\" (and the reverse) once.",
            "default": true
          },
          "respectRobotsTxt": {
            "title": "Respect robots.txt",
            "type": "boolean",
            "description": "Skip pages the site's robots.txt disallows.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}