Create a buy box
curl --request POST \
--url https://api.investorlift.com/marketplace/v1/buy/buy-boxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"geo_feature_ids": [
"<string>"
],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [],
"deal_type": [],
"asset_type": [],
"verified_only": true
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
geo_feature_ids: ['<string>'],
criteria: {
price_min: 4503599627370495,
price_max: 4503599627370495,
arv_min: 4503599627370495,
beds_min: 4503599627370495,
beds_max: 4503599627370495,
baths_min: 1,
baths_max: 1,
sq_footage_min: 4503599627370495,
sq_footage_max: 4503599627370495,
year_built_min: 4503599627371296,
year_built_max: 4503599627371296,
property_type: [],
deal_type: [],
asset_type: [],
verified_only: true
}
})
};
fetch('https://api.investorlift.com/marketplace/v1/buy/buy-boxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.investorlift.com/marketplace/v1/buy/buy-boxes"
payload = {
"name": "<string>",
"geo_feature_ids": ["<string>"],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [],
"deal_type": [],
"asset_type": [],
"verified_only": True
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "<string>",
"name": "<string>",
"is_default": true,
"geo_feature_ids": [
"<string>"
],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [
"single_family"
],
"deal_type": [
"subject_to"
],
"asset_type": [
"property"
],
"condition_min": "FULL_GUT",
"condition_max": "FULL_GUT",
"verified_only": true
},
"alerts": {
"webhook": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"api_version": "<string>"
}
}{
"type": "https://developers.investorlift.com/marketplace/errors#invalid_body",
"title": "Body unusable",
"status": 400,
"code": "invalid_body",
"detail": "<string>",
"recovery": "Send a JSON body with the content type application/json.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#unauthorized",
"title": "Not authenticated",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"recovery": "Send a current access token for this API, and start a new authorization when the token is expired.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#designation_required",
"title": "Designation missing",
"status": 403,
"code": "designation_required",
"detail": "<string>",
"recovery": "Finish the onboarding of the side you call, then repeat the call.",
"request_id": "<string>",
"designation": "seller"
}{
"type": "https://developers.investorlift.com/marketplace/errors#method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "<string>",
"recovery": "Use one of the methods the documentation lists for this path.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#idempotency_conflict",
"title": "Key reused with a different body",
"status": 409,
"code": "idempotency_conflict",
"detail": "<string>",
"recovery": "Send a new Idempotency-Key for this body, because the stored key holds another one.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#validation_failed",
"title": "Body failed validation",
"status": 422,
"code": "validation_failed",
"detail": "<string>",
"recovery": "Correct each field the detail names, then repeat the call.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#origin_error",
"title": "Service unavailable",
"status": 503,
"code": "origin_error",
"detail": "<string>",
"recovery": "Repeat the call in a minute, and tell Investorlift support when the answer stays the same.",
"request_id": "<string>"
}buy
Create a buy box
Creates one buy box. A box states at least one geography feature and a price range, because a box with no geography matches every deal. One buyer keeps five boxes.
POST
/
buy
/
buy-boxes
Create a buy box
curl --request POST \
--url https://api.investorlift.com/marketplace/v1/buy/buy-boxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"geo_feature_ids": [
"<string>"
],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [],
"deal_type": [],
"asset_type": [],
"verified_only": true
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
geo_feature_ids: ['<string>'],
criteria: {
price_min: 4503599627370495,
price_max: 4503599627370495,
arv_min: 4503599627370495,
beds_min: 4503599627370495,
beds_max: 4503599627370495,
baths_min: 1,
baths_max: 1,
sq_footage_min: 4503599627370495,
sq_footage_max: 4503599627370495,
year_built_min: 4503599627371296,
year_built_max: 4503599627371296,
property_type: [],
deal_type: [],
asset_type: [],
verified_only: true
}
})
};
fetch('https://api.investorlift.com/marketplace/v1/buy/buy-boxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.investorlift.com/marketplace/v1/buy/buy-boxes"
payload = {
"name": "<string>",
"geo_feature_ids": ["<string>"],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [],
"deal_type": [],
"asset_type": [],
"verified_only": True
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "<string>",
"name": "<string>",
"is_default": true,
"geo_feature_ids": [
"<string>"
],
"criteria": {
"price_min": 4503599627370495,
"price_max": 4503599627370495,
"arv_min": 4503599627370495,
"beds_min": 4503599627370495,
"beds_max": 4503599627370495,
"baths_min": 1,
"baths_max": 1,
"sq_footage_min": 4503599627370495,
"sq_footage_max": 4503599627370495,
"year_built_min": 4503599627371296,
"year_built_max": 4503599627371296,
"property_type": [
"single_family"
],
"deal_type": [
"subject_to"
],
"asset_type": [
"property"
],
"condition_min": "FULL_GUT",
"condition_max": "FULL_GUT",
"verified_only": true
},
"alerts": {
"webhook": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"api_version": "<string>"
}
}{
"type": "https://developers.investorlift.com/marketplace/errors#invalid_body",
"title": "Body unusable",
"status": 400,
"code": "invalid_body",
"detail": "<string>",
"recovery": "Send a JSON body with the content type application/json.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#unauthorized",
"title": "Not authenticated",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"recovery": "Send a current access token for this API, and start a new authorization when the token is expired.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#designation_required",
"title": "Designation missing",
"status": 403,
"code": "designation_required",
"detail": "<string>",
"recovery": "Finish the onboarding of the side you call, then repeat the call.",
"request_id": "<string>",
"designation": "seller"
}{
"type": "https://developers.investorlift.com/marketplace/errors#method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "<string>",
"recovery": "Use one of the methods the documentation lists for this path.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#idempotency_conflict",
"title": "Key reused with a different body",
"status": 409,
"code": "idempotency_conflict",
"detail": "<string>",
"recovery": "Send a new Idempotency-Key for this body, because the stored key holds another one.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#validation_failed",
"title": "Body failed validation",
"status": 422,
"code": "validation_failed",
"detail": "<string>",
"recovery": "Correct each field the detail names, then repeat the call.",
"request_id": "<string>"
}{
"type": "https://developers.investorlift.com/marketplace/errors#origin_error",
"title": "Service unavailable",
"status": 503,
"code": "origin_error",
"detail": "<string>",
"recovery": "Repeat the call in a minute, and tell Investorlift support when the answer stays the same.",
"request_id": "<string>"
}Authorizations
Authorization code with PKCE. The person grants the scopes on the Investorlift consent page and accepts the Marketplace API Terms there.
Headers
A key of your own that names this attempt. The same key with the same body replays the stored answer.
Required string length:
1 - 255Body
application/json
Was this page helpful?