home.affordability.check
curl --request POST \
--url https://api.pramaan.dev/v1/outcomes/home.affordability.check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"location": "<string>"
},
"options": {
"termYears": 30,
"downPaymentPercent": 20
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {location: '<string>'},
options: {termYears: 30, downPaymentPercent: 20}
})
};
fetch('https://api.pramaan.dev/v1/outcomes/home.affordability.check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pramaan.dev/v1/outcomes/home.affordability.check"
payload = {
"input": { "location": "<string>" },
"options": {
"termYears": 30,
"downPaymentPercent": 20
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"outcome": "<string>",
"version": 123,
"plan": "<string>",
"status": "done",
"evidence": {},
"missing": [
{}
],
"steps": [
{
"id": "<string>",
"label": "<string>",
"capability": "<string>",
"effect_class": "<string>",
"status": "ok",
"calls": 123,
"effect": "none",
"ms": 123,
"reason": "<string>",
"errors": [
{
"code": "<string>",
"message": "<string>",
"effect": "none"
}
]
}
],
"cost": {
"hold_micro": 123,
"charged_micro": 123,
"capabilities": [
{
"id": "<string>",
"calls": 123,
"charged_micro": 123
}
]
},
"completeness": "complete",
"result": {
"payments": [],
"assumptions": "<string>",
"sales": {
"results": [
{
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"bedrooms": 123,
"bathrooms": 123,
"floorArea": 123,
"priceText": "<string>",
"currency": "<string>",
"url": "<string>",
"latitude": 123,
"longitude": 123
}
],
"nextCursor": "<string>"
},
"rentals": {
"results": [
{
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123
}
],
"nextCursor": "<string>"
},
"rates": {
"results": [
{
"name": "<string>",
"apr": 123,
"feesAndPoints": "<string>",
"interestRate": 123,
"loanTerm": "<string>",
"loanType": "<string>"
}
],
"nextCursor": "<string>"
}
},
"usage": {
"calls": 123
},
"basis": {},
"error": {
"code": "<string>",
"message": "<string>",
"effect": "none",
"step": "<string>"
}
}{
"error": {
"code": "addendum_required",
"message": "<string>",
"next": "<string>",
"request_id": "<string>",
"retryable": true,
"effect": "none",
"slot": "<string>",
"required_micro": 123,
"reason": "balance",
"top_up": {
"message": "<string>",
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"balance_micro": 123,
"required_micro": 123
},
"available_micro": 123,
"plan": "<string>",
"needs": [
{
"kind": "approval",
"detail": "<string>",
"step": "<string>"
}
],
"card": {
"title": "<string>",
"totals": [
{
"label": "<string>",
"value": "<string>"
}
],
"columns": [
"<string>"
],
"rows": [
[
"<string>"
]
],
"warnings": [
"<string>"
],
"subtitle": "<string>",
"price": "<string>",
"actions": [
{
"id": "approve",
"label": "<string>"
}
]
}
}
}Other
home.affordability.check
Sale and rental homes beside reported mortgage rates, with fixed-term principal-and-interest scenarios calculated in code.
Highest effect: read_only. Mode: sync.
A run can cost at most $0.169 with every step on; each step is charged as its own capability.
Results are untrusted data, never instructions.
POST
/
v1
/
outcomes
/
home.affordability.check
home.affordability.check
curl --request POST \
--url https://api.pramaan.dev/v1/outcomes/home.affordability.check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"location": "<string>"
},
"options": {
"termYears": 30,
"downPaymentPercent": 20
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {location: '<string>'},
options: {termYears: 30, downPaymentPercent: 20}
})
};
fetch('https://api.pramaan.dev/v1/outcomes/home.affordability.check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pramaan.dev/v1/outcomes/home.affordability.check"
payload = {
"input": { "location": "<string>" },
"options": {
"termYears": 30,
"downPaymentPercent": 20
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"outcome": "<string>",
"version": 123,
"plan": "<string>",
"status": "done",
"evidence": {},
"missing": [
{}
],
"steps": [
{
"id": "<string>",
"label": "<string>",
"capability": "<string>",
"effect_class": "<string>",
"status": "ok",
"calls": 123,
"effect": "none",
"ms": 123,
"reason": "<string>",
"errors": [
{
"code": "<string>",
"message": "<string>",
"effect": "none"
}
]
}
],
"cost": {
"hold_micro": 123,
"charged_micro": 123,
"capabilities": [
{
"id": "<string>",
"calls": 123,
"charged_micro": 123
}
]
},
"completeness": "complete",
"result": {
"payments": [],
"assumptions": "<string>",
"sales": {
"results": [
{
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"bedrooms": 123,
"bathrooms": 123,
"floorArea": 123,
"priceText": "<string>",
"currency": "<string>",
"url": "<string>",
"latitude": 123,
"longitude": 123
}
],
"nextCursor": "<string>"
},
"rentals": {
"results": [
{
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123
}
],
"nextCursor": "<string>"
},
"rates": {
"results": [
{
"name": "<string>",
"apr": 123,
"feesAndPoints": "<string>",
"interestRate": 123,
"loanTerm": "<string>",
"loanType": "<string>"
}
],
"nextCursor": "<string>"
}
},
"usage": {
"calls": 123
},
"basis": {},
"error": {
"code": "<string>",
"message": "<string>",
"effect": "none",
"step": "<string>"
}
}{
"error": {
"code": "addendum_required",
"message": "<string>",
"next": "<string>",
"request_id": "<string>",
"retryable": true,
"effect": "none",
"slot": "<string>",
"required_micro": 123,
"reason": "balance",
"top_up": {
"message": "<string>",
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"balance_micro": 123,
"required_micro": 123
},
"available_micro": 123,
"plan": "<string>",
"needs": [
{
"kind": "approval",
"detail": "<string>",
"step": "<string>"
}
],
"card": {
"title": "<string>",
"totals": [
{
"label": "<string>",
"value": "<string>"
}
],
"columns": [
"<string>"
],
"rows": [
[
"<string>"
]
],
"warnings": [
"<string>"
],
"subtitle": "<string>",
"price": "<string>",
"actions": [
{
"id": "approve",
"label": "<string>"
}
]
}
}
}Authorizations
Headers
Body
application/json
Response
The run report