curl --request GET \
--url https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "uwi_01J9ZK4P",
"object": "underwriting_inputs",
"status": "processing",
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"progress": {
"phase": "ingesting",
"detail": "<string>"
},
"document_ids": [
"<string>"
],
"asset_class": "multifamily",
"investment_strategy": "<string>",
"schema_version": "underwriting_inputs.v1",
"billed": {
"rate_code": "<string>",
"units": 123,
"amount_usd": "<string>"
},
"billed_total_usd": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"elapsed_seconds": 123,
"poll_after_seconds": 123,
"result_url": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
}
}Retrieve an underwriting-inputs job (poll for status)
Runs take roughly 5-20 minutes: documents are ingested first
(progress.phase = ingesting), then read field by field
(matching).
Pass wait to long-poll instead of sleeping between calls. While a
job is active the response carries poll_after_seconds and a
Retry-After header — use those rather than a fixed interval.
A job cannot exceed 90 minutes; past that the worker fails it and refunds it in full.
curl --request GET \
--url https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trycactus.com/v1/underwriting-inputs/{underwriting_inputs_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "uwi_01J9ZK4P",
"object": "underwriting_inputs",
"status": "processing",
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"progress": {
"phase": "ingesting",
"detail": "<string>"
},
"document_ids": [
"<string>"
],
"asset_class": "multifamily",
"investment_strategy": "<string>",
"schema_version": "underwriting_inputs.v1",
"billed": {
"rate_code": "<string>",
"units": 123,
"amount_usd": "<string>"
},
"billed_total_usd": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"elapsed_seconds": 123,
"poll_after_seconds": 123,
"result_url": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Partner API key issued by Cactus.
Path Parameters
Query Parameters
Seconds to hold the request open waiting for the job to reach a
terminal state (long polling). 0 (the default) returns the current
state immediately.
The response returns as soon as the job completes or fails, so a
short job costs one request instead of a sleep loop. If the budget
runs out first the request still returns 200 with the job's
current state — a still-running job is not an error. Check status
and call again.
Capped at 45 seconds, below the 60-second request timeout.
0 <= x <= 45Response
Current job state.
"uwi_01J9ZK4P"
"underwriting_inputs"processing, completed, failed Present while the job is active.
Show child attributes
Show child attributes
multifamily, self-storage, industrial-outdoor-storage, commercial, industrial, office, retail, hotel "underwriting_inputs.v1"Show child attributes
Show child attributes
Whole seconds since created_at. Present while the job is active.
Recommended seconds to wait before polling again. Mirrors the Retry-After header.
Present when completed.
Show child attributes
Show child attributes