{
  "openapi": "3.0.1",
  "info": {
    "title": "🌐 Proxy Scraper",
    "description": null,
    "version": "0.1",
    "x-build-id": "LbHnaFuRs1yZDy3kh"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/api-empire~proxy-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-api-empire-proxy-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/api-empire~proxy-scraper/runs": {
      "post": {
        "operationId": "runs-sync-api-empire-proxy-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/api-empire~proxy-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-api-empire-proxy-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": {
          "protocol": {
            "title": "📡 Protocol",
            "enum": [
              "all",
              "http",
              "https",
              "socks4",
              "socks5"
            ],
            "type": "string",
            "description": "Which protocols to collect. **All** mixes every list together; pick one to keep the dataset focused.",
            "default": "all"
          },
          "maxItems": {
            "title": "🎯 Max proxies",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Hard cap on dataset rows. Set `0` to disable the cap (collects everything available).",
            "default": 10
          },
          "country": {
            "title": "🗺️ Country filter",
            "enum": [
              "",
              "US",
              "GB",
              "DE",
              "FR",
              "NL",
              "CA",
              "IN",
              "BR",
              "RU",
              "CN",
              "JP",
              "AU",
              "IT",
              "ES",
              "PL",
              "UA",
              "ID",
              "VN",
              "TH",
              "PH",
              "MX",
              "TR",
              "KR",
              "SG",
              "HK",
              "TW",
              "MY",
              "SA",
              "AE",
              "EG",
              "ZA",
              "NG",
              "AR",
              "CO",
              "CL",
              "PE",
              "RO",
              "CZ",
              "SE",
              "NO",
              "FI",
              "DK",
              "BE",
              "AT",
              "CH",
              "PT",
              "GR",
              "HU",
              "IL",
              "PK",
              "BD",
              "IR",
              "KZ",
              "VE",
              "EC",
              "IE",
              "NZ",
              "RS",
              "BG",
              "HR",
              "SK",
              "SI",
              "LT",
              "LV",
              "EE",
              "BY",
              "MD",
              "GE",
              "AM",
              "AZ",
              "UZ",
              "IQ",
              "JO",
              "LB",
              "KW",
              "QA",
              "BH",
              "OM",
              "MA",
              "DZ",
              "TN",
              "KE",
              "GH",
              "ET",
              "TZ",
              "UG",
              "CM",
              "SN",
              "CI",
              "BO",
              "PY",
              "UY",
              "CR",
              "PA",
              "DO",
              "GT",
              "HN",
              "SV",
              "NI",
              "CU",
              "JM",
              "TT",
              "LK",
              "NP",
              "MM",
              "KH",
              "LA",
              "MN"
            ],
            "type": "string",
            "description": "Pick a country to keep only matching proxies, or choose **All countries** for no filter. When set, the actor stops geo-enriching as soon as enough matches are found.",
            "default": ""
          },
          "enableGeoEnrichment": {
            "title": "🛰️ Enable geo enrichment",
            "type": "boolean",
            "description": "When **on**, proxies missing a country are batch-resolved via `ip-api.com` so country filters work for every source. Turn **off** for faster runs when you don't need a country filter.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "🔐 Datacenter fallback proxy",
            "type": "object",
            "description": "Optional. Defaults to Apify Datacenter when blocking is detected. Residential is always used as the second-stage fallback regardless of this setting."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}