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 Offer Requests API

Create, read, and update partner offer requests

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

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

This API exposes 3 operations across 3 paths, and defines 7 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.

3 operations 3 paths 7 schemas 1 GET1 PATCH1 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 Offer Requests 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 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Offer Requests 3

Create, read, and update partner offer requests

POST
/api/1.0.0/partner/offer-request/
Create an offer request
createOfferRequest body → 201400401
GET
/api/1.0.0/estimate/sell/{preliminary_offer_id}/
Offer Estimate Information
getOfferEstimate 2 params → 200401
PATCH
/api/1.0.0/partner/offer-request/{offer_request_id}/agent/
Update offer request agent
updateOfferRequestAgent 1 param body → 200400401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are OfferRequest (35 properties), OfferBreakdown (32 properties), OfferEstimate (10 properties), EstimateAddress (5 properties). Each schema is shown below with its type and property counts.

EstimateAddress
object
5 properties
OfferBreakdown
object
32 properties
ErrorEnvelope
object
2 properties
OfferEstimateWithAgent
OfferRequest
object
35 properties 8 required
Agent
object
4 properties
OfferEstimate
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

homeward-offer-requests-api-openapi.yml Raw ↑

Other APIs Homeward publishes across the network.

Homeward Buybox API
Homeward Finalization API