{
  "openapi": "3.0.1",
  "info": {
    "title": "Allegro Keyword Scraper: Autocomplete & Long-Tail Keywords",
    "description": "Allegro.pl keyword research without a subscription. Collect the search suggestions shoppers see as they type: long-tail phrases, popular searches, brands and categories. Alphabet expansion, recursive depth, dedup. Export as CSV, Excel, JSON or a plain keyword list.",
    "version": "0.0",
    "x-build-id": "mMAGZHXzR7D5Nvqlw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/epicscrapers~allegro-keyword-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-epicscrapers-allegro-keyword-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/epicscrapers~allegro-keyword-scraper/runs": {
      "post": {
        "operationId": "runs-sync-epicscrapers-allegro-keyword-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/epicscrapers~allegro-keyword-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-epicscrapers-allegro-keyword-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": {
          "keywords": {
            "title": "Seed keywords",
            "type": "array",
            "description": "Phrases to research, one per entry (e.g. lego, kawa ziarnista). The actor collects what Allegro's search box suggests for each. An Allegro listing URL with a string= parameter also works.",
            "items": {
              "type": "string"
            }
          },
          "expansion": {
            "title": "Alphabet expansion",
            "enum": [
              "none",
              "alphabet",
              "alphabetPrefix",
              "both"
            ],
            "type": "string",
            "description": "Also query each seed with every letter a-z, the way a shopper keeps typing. \"Seed + letter\" (lego a, lego b, ...) finds long-tail phrases that continue the seed; \"Letter + seed\" (a lego, b lego, ...) finds phrases where the seed comes later. Each adds 26 requests per seed.",
            "default": "alphabet"
          },
          "includePolishLetters": {
            "title": "Add Polish letters (ą ć ę ł ń ó ś ź ż)",
            "type": "boolean",
            "description": "Also expand with Polish letters. Allegro mostly treats them like their plain letters (lego ą returns the same as lego a), so this rarely adds keywords.",
            "default": false
          },
          "includeDigits": {
            "title": "Add digits (0-9)",
            "type": "boolean",
            "description": "Also expand with digits, e.g. lego 1 (finds set numbers, sizes, models such as lego 10+, lego 11512).",
            "default": false
          },
          "depth": {
            "title": "Depth",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "1 queries only the seeds (and their alphabet expansion). 2 also queries every keyword found at depth 1, and 3 goes one level further. Each level multiplies the number of requests; use Max keywords to cap the run.",
            "default": 1
          },
          "maxKeywords": {
            "title": "Max keywords",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many unique keywords in total. You are never charged for more. Set to 0 for no limit.",
            "default": 1000
          },
          "suggestionsPerQuery": {
            "title": "Suggestions per query",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many phrase suggestions to request per query. The app shows 10; Allegro returns up to 50. Related-search tiles come on top.",
            "default": 50
          },
          "onlyContainingSeed": {
            "title": "Only keywords containing the seed",
            "type": "boolean",
            "description": "Keep only suggestions that contain every word of their seed as a whole word (ignoring case, word order and Polish accents; other word forms such as kawy for kawa do not match). Off keeps related phrases too, e.g. kalendarz adwentowy for lego a.",
            "default": false
          },
          "includePopular": {
            "title": "Include popular searches",
            "type": "boolean",
            "description": "Also save Allegro's \"Popularne wyszukiwania\" (popular searches shown for an empty search box). Each of 10 requests returns 5 random popular phrases, about 40-50 unique per run. Works without seed keywords.",
            "default": false
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "Optional Allegro category ID (the number at the end of a category URL, e.g. 11818 for allegro.pl/kategoria/zabawki-11818). Rows then get categoryId, categoryName and links to the search inside that category. Allegro suggests the same phrases either way."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxy works for this API. On repeated blocks the actor retries through residential IPs in Poland automatically.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}