> ## Documentation Index > Fetch the complete documentation index at: https://docs.poix.io/llms.txt > Use this file to discover all available pages before exploring further. # Get search results > This endpoint retrieves search results based on the provided query parameters. This endpoint allows you to retrieve search results based on a query string. You can specify the number of results you want to retrieve, or paginate through the results. ### Price The cost of this request is \$0.00203 per request. ## OpenAPI ````yaml get /search openapi: 3.1.0 info: version: 1.0.0 title: Poix API servers: - url: https://api.poix.io description: Production server security: [] paths: /search: get: summary: Get search results description: >- This endpoint retrieves search results based on the provided query parameters. operationId: getSearchResults parameters: - schema: type: string description: Specifies the query term to search for. required: false description: Specifies the query term to search for. name: q in: query - schema: type: string minLength: 24 maxLength: 24 pattern: ^UC description: >- Indicates that the API response should only contain resources created by the channel. required: false description: >- Indicates that the API response should only contain resources created by the channel. name: channelId in: query - schema: type: string enum: - any - show - channelTypeUnspecified description: Lets you restrict a search to a particular type of channel. required: false description: Lets you restrict a search to a particular type of channel. name: channelType in: query - schema: type: string default: '50' description: >- Specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. required: false description: >- Specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. name: maxResults in: query - schema: type: string enum: - searchSortUnspecified - date - rating - relevance - title - videoCount - viewCount default: relevance description: >- Specifies the method that will be used to order resources in the API response. required: false description: >- Specifies the method that will be used to order resources in the API response. name: order in: query - schema: type: string description: >- Identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. required: false description: >- Identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. name: pageToken in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ description: >- Indicates that the API response should only contain resources created at or after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). required: false description: >- Indicates that the API response should only contain resources created at or after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). name: publishedAfter in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ description: >- Indicates that the API response should only contain resources created before or at the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). required: false description: >- Indicates that the API response should only contain resources created before or at the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). name: publishedBefore in: query - schema: type: string minLength: 2 maxLength: 2 default: en description: >- Instructs the API to return search results for videos that can be viewed in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. required: false description: >- Instructs the API to return search results for videos that can be viewed in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. name: regionCode in: query - schema: type: string description: >- Instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. required: false description: >- Instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. name: relevanceLanguage in: query - schema: type: string enum: - moderate - none - strict - safeSearchSettingUnspecified default: moderate description: >- Indicates whether the search results should include restricted content as well as standard content. required: false description: >- Indicates whether the search results should include restricted content as well as standard content. name: safeSearch in: query - schema: type: string enum: - /m/04rlf - /m/02mscn - /m/0ggq0m - /m/01lyv - /m/02lkt - /m/0glt670 - /m/05rwpb - /m/03_d0 - /m/028sqc - /m/0g293 - /m/064t9 - /m/06cqb - /m/06j6l - /m/06by7 - /m/0gywn - /m/0bzvm2 - /m/025zzc - /m/02ntfj - /m/0b1vjn - /m/02hygl - /m/04q1x3q - /m/01sjng - /m/0403l3g - /m/021bp2 - /m/022dc6 - /m/03hf_rm - /m/06ntj - /m/0jm_ - /m/018jz - /m/018w8 - /m/01cgz - /m/09xp_ - /m/02vx4 - /m/037hz - /m/03tmr - /m/01h7lh - /m/0410tth - /m/07bs0 - /m/07_53 - /m/02jjt - /m/09kqc - /m/02vxn - /m/05qjc - /m/066wd - /m/0f2f9 - /m/019_rr - /m/032tl - /m/027x7n - /m/02wbm - /m/03glg - /m/068hy - /m/041xxh - /m/07c1v - /m/07bxq - /m/07yv9 - /m/098wr - /m/09s1f - /m/0kt51 - /m/01h6rj - /m/05qt0 - /m/06bvp - /m/01k8wb description: >- Indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. required: false description: >- Indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. name: topicId in: query - schema: type: string pattern: ^(video|channel|playlist)(,(video|channel|playlist))*$ default: video,channel,playlist description: >- Restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types. The default value is video,channel,playlist. required: false description: >- Restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types. The default value is video,channel,playlist. name: type in: query - schema: type: string enum: - completed - live - upcoming - none description: >- Restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video. required: false description: >- Restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video. name: eventType in: query - schema: type: string description: >- In conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. required: false description: >- In conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. name: location in: query - schema: type: string description: >- In conjunction with the location parameter, defines a circular geographic area. required: false description: >- In conjunction with the location parameter, defines a circular geographic area. name: locationRadius in: query - schema: type: string enum: - any - closedCaption - none - videoCaptionUnspecified description: >- Indicates whether the API should filter video search results based on whether they have captions. required: false description: >- Indicates whether the API should filter video search results based on whether they have captions. name: videoCaption in: query - schema: type: string enum: - '0' - '1' - '2' - '10' - '15' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' description: Filters video search results based on their category. required: false description: Filters video search results based on their category. name: videoCategoryId in: query - schema: type: string enum: - any - high - standard description: >- Lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. required: false description: >- Lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. name: videoDefinition in: query - schema: type: string enum: - 2d - 3d - any default: any description: Lets you restrict a search to only retrieve 2D or 3D videos. required: false description: Lets you restrict a search to only retrieve 2D or 3D videos. name: videoDimension in: query - schema: type: string enum: - any - long - medium - short - videoDurationUnspecified default: any description: Filters video search results based on their duration. required: false description: Filters video search results based on their duration. name: videoDuration in: query - schema: type: string enum: - any - 'true' - videoEmbeddableUnspecified description: >- Lets you to restrict a search to only videos that can be embedded into a webpage. required: false description: >- Lets you to restrict a search to only videos that can be embedded into a webpage. name: videoEmbeddable in: query - schema: type: string enum: - any - creativeCommon - youtube description: >- Filters search results to only include videos with a particular license. required: false description: >- Filters search results to only include videos with a particular license. name: videoLicense in: query - schema: type: string enum: - any - 'true' - videoPaidProductPlacementUnspecified description: >- Flters search results to only include videos that the creator has denoted as having a paid promotion. required: false description: >- Flters search results to only include videos that the creator has denoted as having a paid promotion. name: videoPaidProductPlacement in: query - schema: type: string enum: - any - 'true' - videoSyndicatedUnspecified description: >- Lets you to restrict a search to only videos that can be played outside youtube.com. required: false description: >- Lets you to restrict a search to only videos that can be played outside youtube.com. name: videoSyndicated in: query - schema: type: string enum: - any - episode - movie - videoTypeUnspecified description: Lets you restrict a search to a particular type of videos. required: false description: Lets you restrict a search to a particular type of videos. name: videoType in: query responses: '200': description: Successful response content: application/json: schema: type: object properties: nextPageToken: type: string prevPageToken: type: string regionCode: type: string totalResults: type: number resultsPerPage: type: number data: type: array items: type: object properties: kind: type: string description: The type of resource returned. videoId: type: string description: The unique ID of the video. publishedAt: type: string description: The date and time when the video was published. publishTime: type: string description: The time the video was published. title: type: string description: The title of the video. description: type: string description: The description of the video. channelId: type: string description: The ID of the channel that owns the video. channelTitle: type: string description: The title of the channel that owns the video. liveBroadcastContent: type: string description: Indicates if the video is a live broadcast. thumbnails: type: object additionalProperties: type: object properties: url: type: string description: The URL of the thumbnail image. width: type: number description: The width of the thumbnail image. height: type: number description: The height of the thumbnail image. required: - url - width - height description: >- The thumbnails for the video, available in different sizes. required: - kind - videoId - publishedAt - publishTime - title - description - channelId - channelTitle - liveBroadcastContent - thumbnails description: Array of search result objects. required: - regionCode - totalResults - resultsPerPage - data example: regionCode: US totalResults: 1000000 resultsPerPage: 5 nextPageToken: CAUQAA data: - kind: youtube#video videoId: 2zmX1cKsu7o publishedAt: '2024-09-23T19:03:49Z' channelId: UCwU_XmppMy9R9k4YJET7R6w title: CRAZY HEAVY Surf BEFORE Beach CLOSED! | RAW Video description: >- September 4, 2024 unleashed a raging Noreaster that made for some ugly, but crazy heavy waves. In true fashion, the boys sent it ... thumbnails: default: url: https://i.ytimg.com/vi/2zmX1cKsu7o/default.jpg width: 120 height: 90 medium: url: https://i.ytimg.com/vi/2zmX1cKsu7o/mqdefault.jpg width: 320 height: 180 high: url: https://i.ytimg.com/vi/2zmX1cKsu7o/hqdefault.jpg width: 480 height: 360 channelTitle: Brett Barley liveBroadcastContent: none publishTime: '2024-09-23T19:03:49Z' - kind: youtube#video videoId: Oygw2a_C1B0 publishedAt: '2024-09-24T08:30:50Z' channelId: UCoicMEw3njXscfwHlaAJVcQ title: SURFING A NEW BOARD IN CLEAN BEACH BREAK WAVES! (RAW POV) description: >- Join me as I surf on my NEW surfboard at 3 different spots! I scored some CLEAN beach break waves around home Business ... thumbnails: default: url: https://i.ytimg.com/vi/Oygw2a_C1B0/default.jpg width: 120 height: 90 medium: url: https://i.ytimg.com/vi/Oygw2a_C1B0/mqdefault.jpg width: 320 height: 180 high: url: https://i.ytimg.com/vi/Oygw2a_C1B0/hqdefault.jpg width: 480 height: 360 channelTitle: Surfing With Noz liveBroadcastContent: none publishTime: '2024-09-24T08:30:50Z' - kind: youtube#video videoId: l0B4vVn57pA publishedAt: '2024-07-22T18:43:36Z' channelId: UCfwsgnjLrzTWbWc3pOsg6xw title: 'Pop-Up Progression #surf #surfing' description: '' thumbnails: default: url: https://i.ytimg.com/vi/l0B4vVn57pA/default.jpg width: 120 height: 90 medium: url: https://i.ytimg.com/vi/l0B4vVn57pA/mqdefault.jpg width: 320 height: 180 high: url: https://i.ytimg.com/vi/l0B4vVn57pA/hqdefault.jpg width: 480 height: 360 channelTitle: Hydro Mind liveBroadcastContent: none publishTime: '2024-07-22T18:43:36Z' - kind: youtube#video videoId: I_74QSTwg-U publishedAt: '2024-09-23T19:40:00Z' channelId: UC6uX6GF5q2JxLjMkyivM2Og title: RETURN THE GURGLE SLAB! description: >- YOUTUBE VIDS CONTINUE WEEKLY AS ALWAYS MY FRIENDS PLEASE SUBSCRIBE to help SUPPORT the channel! thumbnails: default: url: https://i.ytimg.com/vi/I_74QSTwg-U/default.jpg width: 120 height: 90 medium: url: https://i.ytimg.com/vi/I_74QSTwg-U/mqdefault.jpg width: 320 height: 180 high: url: https://i.ytimg.com/vi/I_74QSTwg-U/hqdefault.jpg width: 480 height: 360 channelTitle: Nathan Florence liveBroadcastContent: none publishTime: '2024-09-23T19:40:00Z' - kind: youtube#video videoId: ma67yOdMQfs publishedAt: '2021-01-23T17:00:15Z' channelId: UC--3c8RqSfAqYBdDjIG3UNA title: >- These Were The All-Time Surfing Moments Of The Year | Best Of 2020 description: >- Well, that was a weird ride. Though it hasn't been easy, at least when we fixed our gaze on the ocean — or favorite place in the ... thumbnails: default: url: https://i.ytimg.com/vi/ma67yOdMQfs/default.jpg width: 120 height: 90 medium: url: https://i.ytimg.com/vi/ma67yOdMQfs/mqdefault.jpg width: 320 height: 180 high: url: https://i.ytimg.com/vi/ma67yOdMQfs/hqdefault.jpg width: 480 height: 360 channelTitle: Red Bull Surfing liveBroadcastContent: none publishTime: '2021-01-23T17:00:15Z' '400': description: Bad Request content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: issues: type: array items: type: object properties: code: type: string maximum: type: number type: type: string inclusive: type: boolean exact: type: boolean message: type: string path: type: array items: type: string required: - code - message - path name: type: string enum: - ZodError required: - issues - name required: - success - error example: success: false error: issues: - code: custom message: >- The 'type' property must be set to 'video' when using video-specific parameters path: - type name: ZodError '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: message: type: string required: - message required: - error example: error: message: Forbidden security: - Bearer: [] components: securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````