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

Homeward Buybox API

Property eligibility checks

Homeward Buybox API is one of 3 APIs that Homeward publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Buybox. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.homeward.com.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.homeward.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Homeward Buybox API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authentication (tokenAuth).

  • tokenAuth — Token authentication. Provide the testing or production token issued by Homeward in the Authentication header. Contact api@homeward.com to obtain tokens.

Paths & Operations 1

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

Buybox 1

Property eligibility checks

POST
/buybox/
Buybox eligibility check
checkBuyboxEligibility body → 200422

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are BuyboxRequest (6 properties), BuyboxResult (2 properties). Each schema is shown below with its type and property counts.

BuyboxResult
object
2 properties 1 required
BuyboxRequest
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

homeward-buybox-api-openapi.yml Raw ↑

Other APIs Homeward publishes across the network.

Homeward Finalization API
Homeward Offer Requests API