API Reference

Complete REST API documentation for BrikChain platform

API Version
v1.0
Uptime
99.9%
Avg Response
120ms
Endpoints
13

Categories

Endpoints

Getting Started

Base URL

https://api.brikchain.com/v1

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY
Get your API key from the Developer Portal

Rate Limits

API rate limits vary by endpoint and are returned in response headers:

X-RateLimit-Limit

Max requests per window

X-RateLimit-Remaining

Remaining requests

X-RateLimit-Reset

Reset timestamp (Unix)

Retry-After

Seconds until retry

Quick Start Examples

// Install SDK
npm install @brikchain/sdk

// Import and initialize
import { BrikChain } from '@brikchain/sdk';

const client = new BrikChain({
  apiKey: process.env.BRIKCHAIN_API_KEY,
  environment: 'production' // or 'sandbox'
});

// Example: List properties
const properties = await client.properties.list({
  status: 'active',
  limit: 10,
  page: 1
});

console.log(properties);

SDK Available

We provide official SDKs for JavaScript/TypeScript, Python, and Go. Visit our Developer Portal to download.

Error Codes

200
OK
Request succeeded
201
Created
Resource created successfully
400
Bad Request
Invalid request parameters
401
Unauthorized
Missing or invalid authentication
403
Forbidden
Insufficient permissions
404
Not Found
Resource not found
429
Too Many Requests
Rate limit exceeded
500
Internal Server Error
Server error occurred