API Readme

Overview

This API provides endpoints to access to various social medias. Currently focused on supporting Threads

Getting Started

To get started with this API, follow the instructions below:

Prerequisites

• Have a valid API key (if required) to authenticate and authorize API requests.

API Base URL

The base URL for accessing the API endpoints is: https://socily.p.rapidapi.com/

Authentication

Some endpoints may require authentication for authorized access. Include the API key in the request headers or use another authentication mechanism specified in the endpoint documentation. You’ll need to supply the API key in the X-RapidAPI-Key header.

Response Format

Responses are returned in JSON format by default.

Endpoints

1. GET /user/{id:int}

• Description: Get a user profile.
• Request Parameters: id: a user’s identifier
• Response: Returns the user profile

2. GET /user/{username:str}/id

• Description: Get a user’s identifier based on their instagram handle
• Request Parameters: username: the user’s @ handle
• Response: Returns the user’s thread id if they have an account. null otherwise

3. GET /user/{id:int}/threads

• Description: Get a user’s threads
• Request Parameters: id: a user’s identifier.
• Response: Returns a list of user’s threads

4. GET /user/{id:int}/replies

• Description: Get a user’s replies.
• Request Parameters: id: a user’s identifier
• Response: Returns a list of user’s replies

5. GET /thread/{id:int}

• Description: Get a thread.
• Request Parameters: id: a thread’s identifier.
• Response: Returns the thread

6. GET /thread/{id:int}/likes

• Description: Get a thread’s likers.
• Request Parameters: id: a thread’s identifier.
• Response: Returns the users that like the thread

7. GET /thread/{url_id:str}/id

• Description: Get a thread’ identifier by its URL’s identifier.
• Request Parameters: url_id: a thread’s URL identifier.
• Response: Returns the thread id

Error Handling

The API may return different HTTP status codes and error messages to indicate various scenarios, such as invalid requests, authentication failures, or server errors. Refer to the API documentation for specific error codes and their meanings.

Rate Limiting

To prevent abuse and ensure fair usage, the API may enforce rate limiting at 3 requests/second (higher with mega plan)