Getting Started
Get up and running with the syte API in minutes. This guide will walk you through obtaining an API key, setting up your development environment, and making your first API calls.
Step 1: Obtain Your API Key
To use the syte API, you'll need an API key. API keys are provided to authorized partners and customers for accessing our real estate data and AI capabilities.
Step 2: Set Up Your Development Environment
For the best development experience, we recommend storing your API credentials as environment variables. This allows you to copy and paste commands from this documentation without modification.
Configure Environment Variables
Add these lines to your shell configuration file:
~/.bashrcfor Bash~/.zshrcfor Zsh (default on macOS)~/.config/fish/config.fishfor Fish
Environment Variables
After adding these lines, reload your shell configuration:
Reload Shell Configuration
Step 3: Install Required Dependencies
Depending on your preferred programming language, install the necessary HTTP client libraries:
Python
Install the requests library for making HTTP calls:
Node.js
Install axios for promise-based HTTP requests:
Step 4: Make Your First API Request
Let's test your setup by making a simple request to fetch building information:
Make Your First API Request
Next Steps
Now that you've made your first API request, explore these guides to learn more about the syte developer platform:
Authentication
Learn about API authentication, and best practices for secure API usage.
Read the guide →Geocoding & Data Fetching
Convert addresses to coordinates and fetch data for specific locations.
Read the guide →Building Data
Access comprehensive building information including geometry, usage, and energy data.
Read the guide →