← Back to Home

API Documentation

Authentication

Learn about authentication requirements for the Social Unlocks API.

Overview

The Social Unlocks API is designed to be simple and accessible. All documented endpoints are public and do not require authentication, making them easy to integrate into any application.

Public Endpoints

No Authentication Required
  • • Key Validation API
  • • Lockers by Username API
  • • No API keys needed
  • • No tokens required
Rate Limited

All public endpoints are rate limited to prevent abuse and ensure fair usage for all developers.

Making Requests

Since no authentication is required, you can make requests directly to our API endpoints. Here's what you need to know:

Base URL
https://socialunlocks.com/api

All API requests should be made to this base URL followed by the specific endpoint path.

Content Type
Content-Type: application/json

When making POST requests, include this header to specify the content type.

Response Format
All responses are returned in JSON format

All API responses are returned in JSON format with appropriate HTTP status codes.

Rate Limiting

While no authentication is required, all endpoints are rate limited to prevent abuse:

EndpointRate LimitWindow
Key Validation API100 requestsPer minute per IP
Lockers API60 requestsPer minute per IP

Rate Limit Headers

Rate limit information is included in response headers:

X-RateLimit-Limit- Request limit per window
X-RateLimit-Remaining- Remaining requests in current window
X-RateLimit-Reset- Timestamp when the rate limit resets

Handling Rate Limits

Important: If you exceed the rate limit, you'll receive a 429 status code. Please implement exponential backoff in your applications to handle rate limiting gracefully.

Best Practices
  • • Monitor rate limit headers in your responses
  • • Implement exponential backoff when you hit rate limits
  • • Cache responses when appropriate to reduce API calls
  • • Consider implementing request queuing for high-volume applications

Future Authentication

Note: While current endpoints are public, we may introduce authenticated endpoints in the future for advanced features. We'll provide ample notice and documentation for any changes.