Skip to main content
GET
/
api
/
v1
/
tax-home-analysis
Tax Home Analysis
curl --request GET \
  --url https://api.example.com/api/v1/tax-home-analysis
{
  "year": 2025,
  "available": true,
  "netBenefit": 1250000,
  "roi": 4.2,
  "taxSavings": 1550000,
  "costOfMaintaining": 300000,
  "scenarioA": {
    "label": "With Tax Home",
    "taxableIncome": 2340000,
    "stipends": 2955000,
    "deductionMethod": "standard",
    "appliedDeduction": 1500000,
    "federalTax": 280000,
    "stateTax": 0,
    "seTax": 0,
    "totalTax": 280000,
    "takeHome": 5015000
  },
  "scenarioB": {
    "label": "Itinerant (No Tax Home)",
    "taxableIncome": 5295000,
    "stipends": 0,
    "deductionMethod": "standard",
    "appliedDeduction": 1500000,
    "federalTax": 980000,
    "stateTax": 0,
    "seTax": 0,
    "totalTax": 980000,
    "takeHome": 4315000
  },
  "costBreakdown": {
    "rent": 144000,
    "utilities": 60000,
    "insurance": 36000,
    "return_trips": 30000,
    "visit_mileage": 30000
  },
  "visitMileage": {
    "miles": 420,
    "costCents": 30000,
    "ratePerMile": 70
  }
}
Compares two scenarios: keeping your tax home (stipends tax-free) vs. going itinerant (everything taxable). Returns the net financial benefit of maintaining your tax home.

​
Query Parameters

​
year
string
default:"current year"
Tax year (YYYY format).

​
Response

{
  "year": 2025,
  "available": true,
  "netBenefit": 1250000,
  "roi": 4.2,
  "taxSavings": 1550000,
  "costOfMaintaining": 300000,
  "scenarioA": {
    "label": "With Tax Home",
    "taxableIncome": 2340000,
    "stipends": 2955000,
    "deductionMethod": "standard",
    "appliedDeduction": 1500000,
    "federalTax": 280000,
    "stateTax": 0,
    "seTax": 0,
    "totalTax": 280000,
    "takeHome": 5015000
  },
  "scenarioB": {
    "label": "Itinerant (No Tax Home)",
    "taxableIncome": 5295000,
    "stipends": 0,
    "deductionMethod": "standard",
    "appliedDeduction": 1500000,
    "federalTax": 980000,
    "stateTax": 0,
    "seTax": 0,
    "totalTax": 980000,
    "takeHome": 4315000
  },
  "costBreakdown": {
    "rent": 144000,
    "utilities": 60000,
    "insurance": 36000,
    "return_trips": 30000,
    "visit_mileage": 30000
  },
  "visitMileage": {
    "miles": 420,
    "costCents": 30000,
    "ratePerMile": 70
  }
}
When tax home or assignments are missing: 
{
  "available": false,
  "reason": "No tax home set up"
}
​
netBenefit
integer
taxSavings - costOfMaintaining in cents. Positive means keeping the tax home saves money.
​
roi
number
Return on investment percentage: (taxSavings / costOfMaintaining) * 100. Shows “Free benefit” when cost is $0.