API Documentation

The BJJ RollCall API provides programmatic access to gym information, class schedules, and training data. This RESTful API uses standard HTTP methods and returns JSON responses.

Authentication

The API uses token-based authentication. Include your API token in the Authorization header with the Token prefix.

Getting Your API Token

1. Log in to your BJJ RollCall account
2. Navigate to your profile settings
3. Find your API token in the "API Access" section
4. Keep your token secure - treat it like a password

Authentication Example

curl -H "Authorization: Token YOUR_API_TOKEN_HERE" \
     https://bjjrollcall.com/gyms/api/v1/gyms/1/

Quick Start

Here's a quick example to get you started with the API:

1. Get Gym Information

curl -H "Authorization: Token YOUR_TOKEN" \
     https://bjjrollcall.com/gyms/api/v1/gyms/123/

2. View Gym Timetable

curl -H "Authorization: Token YOUR_TOKEN" \
     https://bjjrollcall.com/gyms/api/v1/gyms/123/timetable/

3. Update Your Gym

curl -X PATCH \
     -H "Authorization: Token YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"description": "Updated gym description"}' \
     https://bjjrollcall.com/gyms/api/v1/gyms/123/update/

API Endpoints

All API endpoints are prefixed with /gyms/api/v1/. The base URL is:

https://bjjrollcall.com/gyms/api/v1/

View Gyms

{
  "id": 123,
  "name": "Sydney BJJ Academy",
  "affiliation": "Gracie Barra",
  "address": "123 Main St, Sydney NSW 2000",
  "suburb": "Sydney",
  "state": "NSW",
  "country": "Australia",
  "website": "https://sydneybjj.com",
  "email": "info@sydneybjj.com",
  "phone": "+61 2 1234 5678",
  "description": "Premier Brazilian Jiu-Jitsu academy in Sydney",
  "latitude": -33.8688,
  "longitude": 151.2093
}

[
  {
    "id": 1,
    "weekday": 1,
    "weekday_display": "Monday",
    "start_time": "18:00:00",
    "end_time": "19:30:00",
    "class_type": "Gi",
    "instructor": "John Smith",
    "level": "All Levels",
    "notes": "Fundamentals class"
  }
]

Manage Your Gym

{
  "name": "Sydney BJJ Academy",
  "address": "123 Main St",
  "suburb": "Sydney",
  "state": "NSW",
  "country": "Australia",
  "website": "https://sydneybjj.com",
  "email": "info@sydneybjj.com",
  "phone": "+61 2 1234 5678"
}

{
  "description": "Updated description for our academy",
  "phone": "+61 2 9999 8888",
  "website": "https://newwebsite.com"
}

Timetable Management

Manage your gym's class schedule through the API. All times should be provided in your local timezone.

{
  "weekday": 0,
  "start_time": "18:00:00",
  "end_time": "19:30:00",
  "class_type": "Gi",
  "instructor": "John Smith",
  "level": "All Levels",
  "notes": "Fundamentals class"
}

Training Notes

Record and manage your personal training notes. These are private to your account.

{
  "gym": 123,
  "date": "2026-02-08",
  "notes": "Worked on triangle chokes from closed guard",
  "techniques": ["Triangle Choke", "Closed Guard"],
  "sparring_rounds": 5
}

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Error Response Format

{
  "error": "Unauthorized",
  "detail": "Authentication credentials were not provided."
}

Rate Limiting

To ensure fair usage and system stability, the API implements rate limiting:

• Authenticated requests: 1000 requests per hour
• Read operations (GET): Higher limits apply
• Write operations (POST, PATCH, DELETE): Lower limits for data integrity

When you exceed the rate limit, you'll receive a 429 Too Many Requests response. The response headers include:

• X-RateLimit-Limit: Your rate limit
• X-RateLimit-Remaining: Requests remaining in current window
• X-RateLimit-Reset: Time when the limit resets (Unix timestamp)

Best Practices

1. Use Environment Variables

Never hardcode API tokens in your source code. Use environment variables:

import os

API_TOKEN = os.getenv('BJJ_ROLLCALL_API_TOKEN')
headers = {'Authorization': f'Token {API_TOKEN}'}

2. Handle Errors Gracefully

Always check response status codes and handle errors appropriately:

response = requests.get(url, headers=headers)
if response.status_code == 200:
    data = response.json()
elif response.status_code == 404:
    print("Gym not found")
else:
    print(f"Error: {response.status_code}")

3. Respect Rate Limits

Implement exponential backoff when rate limited and cache responses when appropriate.

4. Use HTTPS

Always use HTTPS URLs to ensure your API token is transmitted securely.

5. Keep Tokens Secure

Treat API tokens like passwords. Rotate them regularly and revoke compromised tokens immediately.

Support & Resources

Need help with the API? We're here to assist:

• Interactive Documentation: Swagger UI - Test endpoints in your browser
• OpenAPI Schema: Download JSON - Generate client libraries
• Email Support: win@wincor.com.au
• Report Issues: Found a bug? Let us know via email

Last updated: February 2026 | API Version 1.0