This section covers the base details of the Candor Studios Freelancer API and how to implement and use it in your projects.
Before you start, you may want to check if there’s already a library created for your language. Candor Studios owns and maintains 2 official libraries for interacting with the API:
If a library doesn’t exist for your language, a REST API is available instead.
The base URL for the API is https://api.candorstudios.net/api
All endpoints require JSON input and product a JSON output.
Rate limits are implemented using an RPS
, found on the website. Your RPS is how many requests you can make per IP per second. If you need a higher RPS for whatever reason, please make a support ticket or contact us at [email protected].
If you do get rate-limited, the response may (not necessarily always) include a retry_after
(ms) which you can use to determine when to make your next request.
In some cases on some endpoints you may be rate-limited differently to your RPS, and your RPS may change. Instead of relying on your RPS as a figure, please rely on the retry_after
field.
To authenticate, please include your Public API Key in the Authorization
header of every request that you make to the API.