🔑API Reference
Authentication
API keys, OAuth flows, and securing your requests.
⏱️ 12 min read
Authentication Methods
PropTechUSA supports two authentication methods:
API Key Authentication
Include your API key in the Authorization header:
curl https://api.proptechusa.ai/v1/leads \
-H "Authorization: Bearer pk_live_xxxxxxxxxxxxx"
Or using the SDK:
const client = new PropTech({
apiKey: 'pk_live_xxxxxxxxxxxxx',
});
API Key Types
| Type | Prefix | Use Case |
|---|
| Live | pk_live_ | Production environment |
|---|---|---|
| Test | pk_test_ | Development/testing |
Generating API Keys
⚠️ Important: API keys are shown only once. Store them securely.
OAuth 2.0 (Coming Soon)
OAuth 2.0 support is coming soon for applications that need user-level authentication.
Security Best Practices
- Never expose API keys in client-side code
- Use environment variables for all keys
- Implement IP allowlisting for production
- Rotate keys if you suspect compromise
- Use test keys during development