Get YouTube Search Suggestions

cURL

curl --request GET \
  --url https://api.influship.com/v1/raw/youtube/typeahead \
  --header 'X-API-Key: <api-key>'

import Influship from 'influship';

const client = new Influship({
  apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});

const response = await client.raw.youtube.typeahead({ q: 'x' });

console.log(response.data);

{
  "data": {
    "query": "<string>",
    "suggestions": [
      "<string>"
    ],
    "scraped_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "Invalid value for parameter 'limit': must be between 1 and 100",
    "param": "limit",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "API key missing or invalid",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "payment_required",
    "message": "Payment authentication is required.",
    "status_code": 402,
    "reason_code": "PAYMENT_ACTION_REQUIRED",
    "next_step": "complete_authentication",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Your plan does not include access to this endpoint",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded (per minute)",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred. Please try again later.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "service_unavailable",
    "message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "retry_after_seconds": 60,
      "upstream_error": "upstream_rate_limited"
    }
  }
}

GET

raw

youtube

typeahead

cURL

curl --request GET \
  --url https://api.influship.com/v1/raw/youtube/typeahead \
  --header 'X-API-Key: <api-key>'

import Influship from 'influship';

const client = new Influship({
  apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});

const response = await client.raw.youtube.typeahead({ q: 'x' });

console.log(response.data);

{
  "data": {
    "query": "<string>",
    "suggestions": [
      "<string>"
    ],
    "scraped_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "Invalid value for parameter 'limit': must be between 1 and 100",
    "param": "limit",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "API key missing or invalid",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "payment_required",
    "message": "Payment authentication is required.",
    "status_code": 402,
    "reason_code": "PAYMENT_ACTION_REQUIRED",
    "next_step": "complete_authentication",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Your plan does not include access to this endpoint",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded (per minute)",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred. Please try again later.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "service_unavailable",
    "message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "retry_after_seconds": 60,
      "upstream_error": "upstream_rate_limited"
    }
  }
}

Authorizations

X-API-Key

string

header

required

Query Parameters

string

required

Partial search query

Required string length: 1 - 200

country_code

string

default:US

Required string length: 2

language_code

string

default:en

Required string length: 2 - 5

Response

Successful response

data

object

required

Show child attributes

Overview

Endpoints

Get YouTube Search Suggestions

Authorizations

Query Parameters

Response