> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Suggestions API > Get autocomplete phrases for a keyword from Google, YouTube or Amazon. Call the Suggestions API for JSON. 1 credit per call. * **Endpoint:** `suggest` * **Returns:** `data` has `results`. * **Cost:** 1 credit per call. Failed calls cost nothing. * **Paging:** No. ## Example ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.suggest({ source: "youtube", query: "how to learn" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.suggest(source="youtube", query="how to learn") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/suggest \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"source":"youtube","query":"how to learn"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy suggest "how to learn" --source youtube ``` ## OpenAPI ````yaml api-reference/openapi.json POST /v1/suggest openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns. When a response has a cursor, send it back with the same input to get the next page. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/suggest: post: summary: Get autocomplete phrases for a keyword from Google, YouTube or Amazon description: Costs 1 credit per call. operationId: suggest requestBody: required: true content: application/json: schema: oneOf: - type: object properties: query: type: string minLength: 1 maxLength: 200 country: default: us type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. language: default: en type: string pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$ description: >- BCP 47 language tag, e.g. en or pt-BR. Any case is accepted. source: type: string const: google limit: type: integer minimum: 1 maximum: 100 description: >- Return at most this many results from the page. The price stays the same. required: - query - source additionalProperties: false - type: object properties: query: type: string minLength: 1 maxLength: 200 country: default: us type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. language: default: en type: string pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$ description: >- BCP 47 language tag, e.g. en or pt-BR. Any case is accepted. source: type: string const: youtube limit: type: integer minimum: 1 maximum: 100 description: >- Return at most this many results from the page. The price stays the same. required: - query - source additionalProperties: false - type: object properties: query: type: string minLength: 1 maxLength: 200 country: default: us enum: - us - ca - mx - br - gb - de - fr - it - es - nl - be - se - pl - tr - ae - sa - eg - in - jp - au - sg description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. type: string source: type: string const: amazon limit: type: integer minimum: 1 maximum: 100 description: >- Return at most this many results from the page. The price stays the same. required: - query - source additionalProperties: false example: source: youtube query: how to learn responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: anyOf: - type: object additionalProperties: false properties: results: type: array items: type: object additionalProperties: false properties: keyword: type: string minLength: 1 rank: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - keyword - rank required: [] - type: object additionalProperties: false properties: results: type: array items: type: object additionalProperties: false properties: keyword: type: string minLength: 1 rank: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - keyword - rank required: [] - type: object additionalProperties: false properties: results: type: array items: type: object additionalProperties: false properties: keyword: type: string minLength: 1 rank: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - keyword - rank required: [] creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - agentCodeCompleted - agentCodeNotFound - agentEmailMismatch - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ````