Articles

API Playground

Test this API route directly in your browser using our interactive Swagger documentation. Simply authenticate with your API key, input parameters, and execute requests to see real-time responses and understand how each endpoint behaves.

HTTP server response

The Guavy API uses standard HTTP response codes and JSON formatting for all responses. This consistent structure allows for predictable parsing and error handling in your applications.

Response Structure

All responses from the API are delivered as JSON objects with the following characteristics:

• HTTP status codes indicate the result category (2xx for success, 4xx for client errors, 5xx for server errors)
• Content is always delivered with the application/json MIME type
• Successful responses wrap data in a Success object
• Error responses include descriptive messages to help troubleshoot issues

A successful response will look like this:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 30

{
    "Success": {
        // Response payload containing requested data
    }
}

For large responses, consider implementing pagination using the limit and skip parameters where available to improve performance.

API response format

The Guavy API generally follows REST conventions, with some deviations.

• All responses are wrapped in a top-level object.
• Responses return either `Success` or `Error`.
• Errors include a message field with details about the error.
• All responses use the generic JSON content type.

An example of a successful response from this API endpoint is shown below:

{
    "Success": 
      {
        "date" : number
        "title" : string
        "body" : string
        "clout" : number
        "nouns" : array
        "verbs" : array
        "mentions" : array
        "sentiment" : number
      }
    
}