Skip to content

OpendoorClient

Constructors

Constructor

new OpendoorClient(config): OpendoorClient

Parameters

config

OpendoorClientConfig

Returns

OpendoorClient

Methods

createOffer()

createOffer(data): Promise<CreateOfferResponse>

Create an offer request for an address.

Parameters

data

CreateOfferRequest

Address and optional correlation ID

Returns

Promise<CreateOfferResponse>

Offer request ID, status, and denial info if denied


getAddressSuggestions()

getAddressSuggestions(query): Promise<AddressSuggestionsResponse>

Search for addresses matching a query string.

Parameters

query

string

Partial address string

Returns

Promise<AddressSuggestionsResponse>

Matching addresses


getAssessmentSlots()

getAssessmentSlots(params): Promise<GetAssessmentSlotsResponse>

Get available assessment time slots for an offer.

Parameters

params

GetAssessmentSlotsRequest

Contains the offerId

Returns

Promise<GetAssessmentSlotsResponse>

Available slots and scheduling metadata


getHomeDetail()

getHomeDetail(params): Promise<GetHomeDetailResponse>

Get prefilled home detail answers for a property. Returns data for pre-populating questionnaire forms.

Parameters

params

GetHomeDetailRequest

Returns

Promise<GetHomeDetailResponse>


getOffer()

getOffer(offerId): Promise<GetOfferResponse>

Get the current status of an offer request.

Parameters

offerId

string

The opendoorOfferRequestId

Returns

Promise<GetOfferResponse>

Full offer status including pricing data when OFFERED


updateOffer()

updateOffer(offerId, data): Promise<UpdateOfferResponse>

Update an offer request with seller info, home details, or eligibility.

Parameters

offerId

string

The opendoorOfferRequestId

data

UpdateOfferRequest

Fields to update

Returns

Promise<UpdateOfferResponse>

Updated offer status