CTRL+K

APIFreaks

APIFreaks provides RESTful APIs that accept request parameters via HTTP GET or HTTP POST. When sending API requests as HTTP POST, we accept the following content types:

application/json

All our APIs require requests to adhere to HTTP/1.x or HTTP/2 protocols, ensuring seamless compatibility and functionality across integrations.

Authorization

To make authorized requests to our APIs, pass the API key either as a header or as a query parameter. To obtain your API key, log in to the API Freaks dashboard. If your API key has been compromised, you can reset it by clicking the reset button on the dashboard.

Passing API Key in the Header

Header	Description
X-apiKey	Add your private API key to the request headers.

Passing API Key in the Query Parameter

Parameter	Description
apiKey	You can also pass your private API key as a query parameter.

Content Format

We support content negotiation through two methods: by using the format parameter or the Accept header.

Parameter	Description
format	Response format. Possible values are: (1) json (default) (2) xml

Header	Description
Accept	Standard content negotiation as specified in HTTP/1.x, allowing you to receive response bodies in either JSON or XML format.

Custom Response Headers

Each API endpoint supports a defined limit on concurrent requests. This limit helps ensure fair usage and optimal performance. Each successful response includes the following headers to help you monitor and manage your current concurrent request usage. Additionally, responses also include the X-AF-Credits-Cost header to indicate how many credits were consumed for the request.

Header	Description
X-Concurrent-Threads	Specifies the maximum number of concurrent requests allowed.
X-Concurrent-Threads-Active	Indicates the number of active concurrent requests being processed.
X-AF-Credits-Cost	Specifies the number of credits consumed by the current request.

HTTP Errors

In case of an API request failure, 4XX or 5XX HTTP status code will be set. The following specific error fields will also be set in the response body:

Field	Type	Description
timestamp	String	Timestamp of the request formatted according to ISO 8601 standard. (YYYY-MM-DDTHH:MM:SS.sssZ)
path	String	Path of the request
status	Integer	HTTP status code
error	String	Specific Error
message	String	Instructions to resolve the error

Server-side Error Codes

The Error codes specific to API endpoint are listed in the respective documentation pages. In general, API Freaks can return the following HTTP error codes.

HTTP Status	Reasons
400	Please provide apikey.
400	Please pass correct parameters.
400	Please provide data in required format in request body. (In case of HTTP POST requests)
400	Please provide correct headers
401	Provided API key is invalid. [For Technical Support: support@apifreaks.com]
401	The Request IP is blocked to access this API.
402	Credits subscription is deactivated. Please buy new plan or add one-off credits for using ApiFreaks [For Technical Support: support@apifreaks.com].
402	Subscription credits allowed limit exceeded. Please buy new plan or add one-off credits for using APIFreaks.
402	One-off Credits limit reached. Please buy subscription credits or add one-off credits to use APIFreaks.
402	Subscription surcharge credits limit exceeded. Please buy new plan or add one-off credits for using APIFreaks.
403	Your account is not active. [For Technical Support: support@apifreaks.com].
403	One-off Credits are not active Contact support: support@apifreaks.com.
403	Credits subscription is not active. Contact Support: support@apifreaks.com.
403	Subscription surcharge credits is inactive. Contact support: support@apifreaks.com.
403	You need to be organization admin to access this endpoint.
403	Organization admin restricted you to use this API endpoint.
403	Your current account role does not have permission to access this endpoint. Please contact your administrator or support if you believe this is an error.
404	The requested resource could not be found. Please verify the URL and try again.
406	The media type specified in the request is not supported. For more details, please refer to the API documentation.
413	Maximum request body size limit exceeded. (In case of HTTP POST request)
429	Please slow down. Allowed Maximum concurrent request limit has been reached.
500	Internal Server Error occurred [For Technical Support: support@apifreaks.com].
503	Service is unavailable. Please try after some time or contact support@apifreaks.com.
504	Request is timed-out. Please contact at support@apifreaks.com.