Request and Response Format

Requests

Please include a descriptive User-Agent in your requests. This will help us to identify your consumption in our logs.

Responses

API responses are in JSON format. All API responses conform to this interface:

interface ApiResponse<T> {
  success: boolean;
  error?: string;
  data?: T;
}

Always check the success of the response before trying to access its data.