Welcome

Welcome to the documentation for Party Social. Whether you are a seasoned developer or just getting started, this documentation is designed to provide you with all the information you need to get started with our developer platform.

The Party Social API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We support JSON for serialization and for authentication in custom clients, we use JWTs.

Should you encounter any challenges or have questions while using our API, please reach out to us or our community on Discord, https://discord.gg/nzTmfZ8!

Thank you for choosing Party Social and happy coding!

Base URL

For Custom Clients, use wss://party-social.com when connecting with Socket.io.

The base URL for our API is https://api.party-social.com

Rate Limiting

We impose rate limits to maintain the quality of our service. The limits are:

• Three (3) requests every five (5) seconds.

• No API key is required.

When a limit is exceeded, a 429 Too Many Requests status code is returned. We recommend implementing an exponential backoff retry strategy to handle rate limits gracefully.

Error Handling

Party Social uses standard HTTP response codes to indicate the success or failure of an API request. In general:

• Codes in the 2xx range indicate success.

• Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted).

• Codes in the 5xx range indicate an error with Party Social's servers.

Security

All requests to our API require HTTPS to ensure data privacy and security.