{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Traffic Checker - Rankings, Keywords & Competitors",
    "description": "Check any website's estimated monthly search traffic, Google ranking footprint, top keywords and organic competitors. Bulk domains, 88 countries, pay per row. Traffic is estimated from Google organic rankings, not panel/clickstream total visits.",
    "version": "0.0",
    "x-build-id": "YuQy5M7a7rSossP7p"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~website-traffic-checker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-website-traffic-checker",
        "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/memo23~website-traffic-checker/runs": {
      "post": {
        "operationId": "runs-sync-memo23-website-traffic-checker",
        "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/memo23~website-traffic-checker/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-website-traffic-checker",
        "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": [
          "domains"
        ],
        "properties": {
          "domains": {
            "title": "Websites",
            "type": "array",
            "description": "Domains to check, one per line. Anything around a domain is removed: `https://www.stripe.com/pricing` becomes `stripe.com`.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Two-letter country code to read Google rankings from (for example `us`, `gb`, `de`, `fr`). Unknown or unsupported codes fall back to `us`.",
            "default": "us"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Labs language code. Leave empty to use the country's main language."
          },
          "includeKeywords": {
            "title": "Include top keywords",
            "type": "boolean",
            "description": "Add the top keywords each domain ranks for in Google organic, with position, volume, estimated traffic and CPC. Billed per keyword.",
            "default": false
          },
          "maxKeywords": {
            "title": "Max keywords per domain",
            "minimum": 1,
            "maximum": 3000,
            "type": "integer",
            "description": "How many keywords to return per domain when 'Include top keywords' is on.",
            "default": 20
          },
          "includeCompetitors": {
            "title": "Include competitors",
            "type": "boolean",
            "description": "Add the sites that compete with each domain in Google organic search, with shared-keyword count and their own footprint. Billed per competitor.",
            "default": false
          },
          "maxCompetitors": {
            "title": "Max competitors per domain",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many competitors to return per domain when 'Include competitors' is on.",
            "default": 10
          },
          "includeFootprint": {
            "title": "Include ranking footprint",
            "type": "boolean",
            "description": "Add the richer ranking breakdown per domain: keywords in the top 3, top 10 and page 2, estimated traffic value, and newly gained or lost keywords. Billed per domain.",
            "default": false
          },
          "minSearchVolume": {
            "title": "Minimum search volume (keywords)",
            "minimum": 0,
            "type": "integer",
            "description": "Only keywords with at least this monthly search volume are fetched and charged. Leave empty for no floor."
          },
          "excludeBrandTerms": {
            "title": "Exclude brand keywords",
            "type": "boolean",
            "description": "Drop keywords that contain the domain's own brand name (for example `stripe login` for stripe.com).",
            "default": false
          },
          "includeWhois": {
            "title": "Domain & registrar (WHOIS)",
            "type": "boolean",
            "description": "Add the domain's registration date, age, registrar, expiry and name servers from the public registry (RDAP).",
            "default": false
          },
          "includeTech": {
            "title": "Tech stack",
            "type": "boolean",
            "description": "Detect the CMS, framework, analytics, hosting and other technologies the site runs, from its homepage.",
            "default": false
          },
          "includePerformance": {
            "title": "Performance (Core Web Vitals)",
            "type": "boolean",
            "description": "Add real-user LCP, INP, CLS, FCP and TTFB from Google CrUX. Requires a free Google CrUX API key configured in the actor.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}