Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Live YouTube Organic Advanced

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

Live YouTube Organic Advanced

​

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.

Body
application/json
  • Type: array (object | null)[]
    • block_depth
      Type: integer | null

      parsing depth optional field number of blocks of results in SERP default value: 20 max value: 200 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results; if the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance

    • device
      Type: string | null

      device type optional field return results for a specific device type available values: desktop, mobile

    • keyword
      Type: string

      keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

    • language_code
      Type: string | null

      search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you 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 example: en

    • language_name
      Type: string | null

      full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you 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 example: English

    • location_code
      Type: integer | null

      search engine location code required field if you don't specify location_name  if you use this field, you don't need to specify location_name you 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 example: 2840

    • location_name
      Type: string | null

      full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you 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 example: United States

    • os
      Type: string | null

      device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android

    • search_param
      Type: string | null

      additional parameters of the search query optional field example: sp=EgIQAg%253D%253D

    • tag
      Type: string | null

      user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Responses
  • 200
    Type: object | null · Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

      general informational message you can find the full list of general informational messages here

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

          task identifier unique task identifier in our system in the UUID format

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: array (object | null)[] | null

          array of results

          • check_url
            Type: string | null

            direct URL to search engine results you can use it to make sure that we provided accurate results

          • datetime
            Type: string | null

            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

          • item_types
            Type: array (string | null)[] | null

            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

          • items
            Type: array (object | null)[] | null

            elements of search results found in SERP

            • block_name
              Type: string | null

              name of the block in SERP
              example:
              "People also watched"

            • block_rank
              Type: integer | null

              block rank in SERP
              position among all the blocks in SERP

            • channel_id
              Type: string | null

              ID of the channel

            • rank_absolute
              Type: integer | null

              absolute rank in SERP for the target domain
              absolute position among all the elements in SERP

            • rank_group
              Type: integer | null

              group rank in SERP
              position within a group of elements with identical type values
              positions of elements with different type values are omitted from rank_group

            • type
              Type: string | null

              type of element

            • url
              Type: string | null

              URL of the channel

          • items_count
            Type: integer | null Format: int64

            the number of results returned in the items array

          • keyword
            Type: string | null

            keyword received in a POST array the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)

          • language_code
            Type: string | null

            language code in a POST array

          • location_code
            Type: integer | null

            location code in a POST array

          • se_domain
            Type: string | null

            search engine domain in a POST array

          • se_results_count
            Type: integer | null Format: int64

            total number of results in SERP

          • spell
            Type: object | null · Response36Afe1097B20_SpellInfo

            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

            • keyword
              Type: string | null

              keyword obtained as a result of search engine autocorrection the results will be provided for the corrected keyword

            • type
              Type: string | null

              type of autocorrection possible values: did_you_mean, showing_results_for, no_results_found_for, including_results_for note: Yahoo and Yandex support only the following autocorrection type: including_results_for

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here

        • status_message
          Type: string | null

          informational message of the task you can find the full list of general informational messages here

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

      the number of tasks in the tasks array returned with an error

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 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
Request Example for post/v1/beta/dataforseo/serp/youtube/organic/live/advanced
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/youtube/organic/live/advanced \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "audi"
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "keyword": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "check_url": null,
          "datetime": null,
          "spell": {
            "keyword": null,
            "type": null
          },
          "item_types": [
            null
          ],
          "se_results_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "rank_group": null,
              "rank_absolute": null,
              "block_rank": null,
              "block_name": null,
              "channel_id": null,
              "url": null
            }
          ]
        }
      ]
    }
  ]
}
Live YouTube Organic Advanced

Need help?