Introduction
In this documentation, we provide a detailed overview of the various components of our GraphQL API. Since many users of this API might not be familiar with GraphQL, we also provide a deep dive into GraphQL.
| Environment | GraphQL Endpoint |
|---|---|
| Development | https://partner.simplersell.com/api/graphql |
| Production | https://partner.opendoor.com/api/graphql |
Supported functionality
Section titled “Supported functionality”Eligibility Checks
Section titled “Eligibility Checks”With our API you can provide us with an address for a home and we will respond with the Opendoor products (if any) that home is eligible for. Currently, the only product we support through our API is our direct sell product. More products are coming soon.
Referrals
Section titled “Referrals”If a home is eligible for direct sell, our API will also return a unique link for your customers to follow to provide further information about their home and complete their offer request. It will automatically attribute and track this referral for you.
Generating Offers
Section titled “Generating Offers”Provide us with an address and a seller’s contact details and we will generate an offer for your customer. Follow this walkthrough and the related documentation to get started.
Status Updates
Section titled “Status Updates”You can use our API to obtain the status of referrals generated by your application by subscribing to our webhook notifications.
Reporting
Section titled “Reporting”You can use our API to obtain a historical record of all home sale leads in our system that have been attached to a referral created by your organization. This includes referrals from the API or from co-branded marketing materials (landing pages, etc.) when applicable. This data is surfaced via the sellerLeads endpoint.