Skip to content
Docs

API Overview

HVAKR provides API access for integrating with other tools and automating workflows.

API Capabilities

Section titled “API Capabilities”

What You Can Do

Section titled “What You Can Do”

The HVAKR API allows you to:

  • Create and manage projects (and their spaces, zones, systems, and types)
  • Run the calculator: loads, register schedules, and the dryside duct graph
  • Look up ASHRAE weather stations
  • Automate repetitive tasks

Use Cases

Section titled “Use Cases”

Common integrations:

  • Import building data from BIM tools
  • Export results to spreadsheets
  • Integrate with project management
  • Automate batch processing

Getting Started

Section titled “Getting Started”

API Access

Section titled “API Access”

To use the API:

  1. Log in to your HVAKR account
  2. Go to Settings → Developer
  3. Click Create Access Token
  4. Copy and save the token — you won’t be able to view it again
  5. Use the token in API requests

API Documentation

Section titled “API Documentation”

Full API reference available at:

Authentication

Section titled “Authentication”

Access Tokens

Section titled “Access Tokens”

API requests use token authentication:

Authorization: Bearer YOUR_TOKEN

Token Security

Section titled “Token Security”

Keep tokens secure:

  • Don’t share tokens
  • Rotate tokens periodically
  • Use environment variables

Client SDKs

Section titled “Client SDKs”

We provide official client libraries to make integration easier.

Learn more about Client SDKs

TypeScript/JavaScript

Section titled “TypeScript/JavaScript”
Terminal window
npm install @hvakr/client

Python

Section titled “Python”
Terminal window
pip install hvakr

Usage & Reliability

Section titled “Usage & Reliability”

API calls are metered for billing on plans with API access. Build clients defensively:

  • Retry transient 5xx responses with exponential backoff
  • Cache results locally and only fetch what you need
  • Contact support@hvakr.com about high-volume or batch workloads

Best Practices

Section titled “Best Practices”

Error Handling

Section titled “Error Handling”

Handle API errors gracefully:

  • Check response status codes
  • Parse error messages
  • Implement retry logic

Efficiency

Section titled “Efficiency”

Optimize API usage:

  • Batch requests when possible
  • Cache results locally
  • Only fetch what you need

Support

Section titled “Support”

Getting Help

Section titled “Getting Help”

For API support: