Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform WebSearch API

The WebSearch API from APIs.io Engineering Platform — 1 operation(s) for websearch.

This API exposes 1 operation across 1 path, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

1 operations 1 paths 31 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform WebSearch API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

WebSearch 1
GET
/search
APIs.io Engineering Platform The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.
Web_Search 21 params → 200default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SearchResponse (10 properties), VideoObject (9 properties), WebPage (6 properties), Error (6 properties). Each schema is shown below with its type and property counts.

MediaObject
object
4 properties
ResponseBase
object
1 property 1 required
WebMetaTag
object
Defines a webpage's metadata.
2 properties
QueryContext
object
Defines the query context that Bing used for the request.
6 properties 1 required
Computation
object
Defines an expression and its answer
2 properties 2 required
Identifiable
object
Defines the identity of a resource.
1 property
SearchResponse
object
Defines the top-level object that the response includes when the request succeeds.
10 properties
News
object
Defines a news answer.
2 properties 1 required
Response
object
Defines a response. All schemas that could be returned at the root of a response should inherit from this
1 property
NewsArticle
Defines a news article.
WebPage
object
Defines a webpage that is relevant to the query.
6 properties
SearchResultsAnswer
object
3 properties
Thing
object
5 properties
Images
object
Defines an image answer
5 properties 1 required
ErrorResponse
object
The top-level response that represents a failed request.
1 property 1 required
SpellSuggestions
object
Defines a suggested query string that likely represents the user's intent. The search results include this response if Bing determines that the user may have i…
1 property 1 required
RelatedSearchesRelatedSearchAnswer
object
Defines a list of related queries made by others.
1 property 1 required
RankingRankingGroup
object
Defines a search results group, such as mainline.
1 property 1 required
Article
object
1 property
TimeZone
object
Defines the data and time of one or more geographic locations.
2 properties 1 required
Query
object
Defines a search query.
5 properties 1 required
RankingRankingItem
object
Defines a search result item to display
6 properties 1 required
RankingRankingResponse
object
Defines where on the search results page content should be placed and in what order.
3 properties
Answer
object
1 property
CreativeWork
object
3 properties
ImageObject
object
Defines an image
1 property
TimeZoneTimeZoneInformation
object
Defines a date and time for a geographical location.
3 properties 3 required
VideoObject
object
Defines a video object that is relevant to the query.
9 properties
Error
object
Defines the error that occurred.
6 properties 2 required
Videos
object
Defines a video answer.
4 properties 1 required
WebWebAnswer
object
Defines a list of relevant webpage links.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-websearch-api-openapi.yml Raw ↑