{
  "openapi": "3.0.1",
  "info": {
    "title": "YouTube Search Scraper",
    "description": "🎥 Extract YouTube search results with full video and channel metadata, including views, likes, subscribers, URLs, thumbnails, and more. 🚀 Fast, reliable, and scalable.",
    "version": "0.0",
    "x-build-id": "IrkeJ0FrI9Jcsd6W5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apt_marble~youtube-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apt_marble-youtube-search-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/apt_marble~youtube-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-apt_marble-youtube-search-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/apt_marble~youtube-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-apt_marble-youtube-search-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",
        "required": [
          "searchTerms"
        ],
        "properties": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "One or more keywords to search YouTube for.",
            "default": [
              "world cup 2026"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxVideosPerTerm": {
            "title": "Maximum videos per search term",
            "minimum": 0,
            "type": "integer",
            "description": "How many regular videos to scrape for each search term.",
            "default": 10
          },
          "maxShortsPerTerm": {
            "title": "Maximum shorts per search term",
            "minimum": 0,
            "type": "integer",
            "description": "How many Shorts to scrape for each search term.",
            "default": 5
          },
          "maxStreamsPerTerm": {
            "title": "Maximum streams per search term",
            "minimum": 0,
            "type": "integer",
            "description": "How many live streams to scrape for each search term. ⚠️ A dedicated live-search pass runs when above 0; if nothing is live for the query, you get 0 streams (that's correct, not an error).",
            "default": 0
          },
          "addFilters": {
            "title": "Add filters",
            "type": "boolean",
            "description": "Enable the search filters below (date, type, length, features). When off, the filter fields are ignored.",
            "default": false
          },
          "sortingOrder": {
            "title": "Sorting order",
            "enum": [
              "relevance",
              "rating",
              "uploadDate",
              "viewCount"
            ],
            "type": "string",
            "description": "How YouTube ranks the results.",
            "default": "relevance"
          },
          "dateFilter": {
            "title": "Date filter",
            "enum": [
              "",
              "hour",
              "today",
              "week",
              "month",
              "year"
            ],
            "type": "string",
            "description": "Only include results uploaded within this window.",
            "default": ""
          },
          "videoTypeFilter": {
            "title": "Video type filter",
            "enum": [
              "",
              "video",
              "channel",
              "playlist",
              "movie"
            ],
            "type": "string",
            "description": "Restrict results to one content type.",
            "default": ""
          },
          "lengthFilter": {
            "title": "Length filter",
            "enum": [
              "",
              "short",
              "medium",
              "long"
            ],
            "type": "string",
            "description": "Restrict results by duration.",
            "default": ""
          },
          "featureHD": {
            "title": "HD",
            "type": "boolean",
            "description": "Only HD videos.",
            "default": false
          },
          "featureSubtitles": {
            "title": "Subtitles/CC",
            "type": "boolean",
            "description": "Only videos with subtitles or closed captions.",
            "default": false
          },
          "featureCC": {
            "title": "Creative Commons",
            "type": "boolean",
            "description": "Only Creative Commons licensed videos.",
            "default": false
          },
          "feature3D": {
            "title": "3D",
            "type": "boolean",
            "description": "Only 3D videos.",
            "default": false
          },
          "featureLive": {
            "title": "Live",
            "type": "boolean",
            "description": "Only live broadcasts.",
            "default": false
          },
          "featurePurchased": {
            "title": "Purchased",
            "type": "boolean",
            "description": "Only purchased content.",
            "default": false
          },
          "feature4K": {
            "title": "4K",
            "type": "boolean",
            "description": "Only 4K videos.",
            "default": false
          },
          "feature360": {
            "title": "360 degrees",
            "type": "boolean",
            "description": "Only 360° videos.",
            "default": false
          },
          "featureLocation": {
            "title": "Location",
            "type": "boolean",
            "description": "Only videos with location data.",
            "default": false
          },
          "featureHDR": {
            "title": "HDR",
            "type": "boolean",
            "description": "Only HDR videos.",
            "default": false
          },
          "featureVR180": {
            "title": "VR180",
            "type": "boolean",
            "description": "Only VR180 videos.",
            "default": false
          },
          "country": {
            "title": "Country (advanced)",
            "type": "string",
            "description": "Two-letter country code for region-specific results (gl).",
            "default": "us"
          },
          "language": {
            "title": "Language (advanced)",
            "type": "string",
            "description": "Two-letter language code for the results (hl).",
            "default": "en"
          },
          "maxConcurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many search terms to process in parallel.",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}