API Documentation

Comprehensive reference for Bitgit's WebSocket and REST APIs.

API Overview

Bitgit provides two main APIs for integration with your development workflow:

  • WebSocket API - For real-time collaboration and events
  • REST API - For managing teams, repositories, and configuration

Both APIs require authentication and provide secure access to your team's collaboration data.

WebSocket API

Real-time collaboration and events

Connect to the WebSocket API to receive real-time updates about team activity, conflicts, and changes.

View WebSocket API docs →

REST API

Team and repository management

Use the REST API to manage teams, repositories, user permissions, and configuration settings.

View REST API docs →

Authentication

All API requests require authentication using API keys or OAuth tokens.

Use your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.bitgit.dev/v1/teams

Base URL

All API requests should be made to:

https://api.bitgit.dev/v1

Rate Limits

API requests are rate limited to ensure fair usage:

  • Free tier: 1,000 requests per hour
  • Pro tier: 10,000 requests per hour
  • Enterprise tier: 100,000 requests per hour

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

API Versioning

The current API version is v1. We maintain backward compatibility and will announce any breaking changes with at least 30 days notice.

Quick Examples

Get team information

example.jsjavascript
const response = await fetch('https://api.bitgit.dev/v1/teams/my-team', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const team = await response.json();
console.log(team);

Explore the APIs

WebSocket API

Real-time events and collaboration

View docs →

REST API

Team and repository management

View docs →

Authentication

API keys and OAuth setup

View docs →