← Back to Home

API Documentation

Introduction

Welcome to the Social Unlocks API documentation. Our platform provides public APIs that allow developers to integrate key validation and locker retrieval functionality into their applications.

Last updated: January 17, 2025

Key Validation API

Validate locker keys and check their expiry status with our simple REST API.

View Documentation
Public Lockers API

Retrieve all active lockers for a specific user by their username.

View Documentation
Authenticated Lockers API

Access your own lockers with full content using API key authentication.

View Documentation

Overview

The Social Unlocks API is designed to be simple, RESTful, and easy to integrate. All endpoints return JSON responses and follow standard HTTP status codes.

Base URL: https://socialunlocks.com/api (or your domain)

Features

Public Endpoints

  • • No authentication required
  • • Simple REST API design
  • • JSON responses
  • • Standard HTTP status codes

Rate Limited

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

Getting Started

Ready to start integrating? Here are the essential steps to get you up and running:

1

Choose Your Endpoint

Browse our API reference to find the endpoint that fits your needs.

2

Review the Documentation

Each endpoint has detailed documentation with examples and response schemas.

3

Start Building

Use our examples to integrate the API into your application.

Need Help?

If you have questions or need assistance, we're here to help:

Developer Support

Email: support@socialunlocks.com

For API-specific questions, please include endpoint details, request/response examples, and a description of your use case.

Happy Coding!

We're excited to see what you build with the Social Unlocks API. If you have suggestions for new endpoints or improvements, please don't hesitate to reach out. We're always looking to make our API better for developers.