# Live YouTube Organic Advanced

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/youtube/organic/live/advanced`

**Tags:** DataForSEO

Returns the ranked results for a keyword on YouTube, synchronously. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. `advanced` is the default choice; take `regular` when only the ranked list matters and `html` only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200.

### Pricing reference

- Metering: Reported response cost.
- Reference request estimate: USD 0.002.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "keyword": {
            "type": "string",
            "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile"
          },
          "block_depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          },
          "search_param": {
            "type": [
              "string",
              "null"
            ],
            "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "audi"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "audi"
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo"
    }
  ]
}
```

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 502 — The service could not complete the request.

### 503 — The API or billing service is temporarily unavailable.

### 504 — The service timed out while processing the request.

### default — Error response; upstream passthrough responses may use provider formats

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```

### Response36Afe1097B20_BaseSerpApiYoutubeOrganicElementItem

`#/components/schemas/Response36Afe1097B20_BaseSerpApiYoutubeOrganicElementItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "rank_group": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>group rank in SERP</em><br>            position within a group of elements with identical <code>type</code> values<br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>"
    },
    "rank_absolute": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> absolute rank in SERP for the target domain</em><br>            absolute position among all the elements in SERP"
    },
    "block_rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>block rank in SERP</em><br>            position among all the blocks in SERP"
    },
    "block_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>name of the block in SERP</em><br>            example:<br>            <code>\"People also watched\"</code><br>"
    },
    "channel_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ID of the channel</em>"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL of the channel</em>"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "youtube_channel": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeChannelElementItem",
      "youtube_video": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeVideoElementItem",
      "youtube_video_paid": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeVideoPaidElementItem",
      "youtube_playlist": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubePlaylistElementItem"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo"
              }
            ]
          },
          "description": "array of tasks"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResultInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "keyword received in a POST array        the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "search engine domain in a POST array"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "location code in a POST array"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "language code in a POST array"
    },
    "check_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "direct URL to search engine results        you can use it to make sure that we provided accurate results"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "date and time when the result was received            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”            example:            2019-11-15 12:57:46 +00:00"
    },
    "spell": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_SpellInfo"
        }
      ],
      "description": "autocorrection of the search engine            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection"
    },
    "item_types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "types of search results in SERP            contains types of search results (items) found in SERP.            possible item types:            youtube_channel, youtube_video, youtube_video_paid, youtube_playlist"
    },
    "se_results_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "total number of results in SERP",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of results returned in the items array",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BaseSerpApiYoutubeOrganicElementItem"
          }
        ]
      },
      "description": "elements of search results found in SERP"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResultInfo"
              }
            ]
          },
          "description": "array of results"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SpellInfo

`#/components/schemas/Response36Afe1097B20_SpellInfo`

```json
{
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "keyword obtained as a result of search engine autocorrection\n the results will be provided for the corrected keyword"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of autocorrection\n possible values:\n did_you_mean, showing_results_for, no_results_found_for, including_results_for\n note: Yahoo and Yandex support only the following autocorrection type:\n including_results_for"
    }
  }
}
```
