Introduction

ServerAvatar API is organized around REST. We follow standard HTTPs Request and Response Format. We accept form-encoded request body and return json-encoded response.

Get Started

  • If you need to use our API, it requires a ServerAvatar account. Please Create An Acoount.

API Endpoint

Note: All Request to the api must be made over HTTPs.

  • The base URL for our API is
https://api.serveravatar.com

Headers

  • Make sure that all your requests are accept: application / json.

HTTP Methods

  • Currently, We are using this HTTP methods GET, POST, PATCH, DELETE.

Status Code

  • 200 Ok

    The HTTP 200 OK success status response code indicates that the request has succeeded.

  • 401 Unauthorized

    The 401 Unauthorized Error is an HTTP response status code indicating that the request sent by the client could not be authenticated.

  • 403 Forbidden

    HTTP 403 is a standard HTTP status code communicated to clients by an HTTP server to indicate that access to the requested (valid) URL by the client is Forbidden for some reason.

  • 404 Not Found

    404 is status code that tells a Web user that a requested page or endpoint is not found.

  • 405 Method Not Allowed

    The method received in the request-line is known by the origin server but not supported by the target resource.

  • 422 Unprocessable Entities

    The 422 status code indicate that some fields are missing for current request which is require.

  • 429 Too Many Request

    Too Many Request. You will get this HTTP Code if you have exceeded rate limits.

  • 500 Internal Server Error

    The 500 status code, or Internal Server Error, means that server cannot process the request for an unknown reason.

  • 503 Service Unavailable / Maintanance

    The 503 Service Unavailable error is an HTTP status code that means the website's server is simply not available right now. Most of the time, it occurs because the server is too busy or because there's maintenance being performed on it.

Rate Limit

All Request will be count. 60 Request Per Minute If you exceed our request limit you will receive HTTP Code 429 (Too Many Request).