Responses

​

Response Format

{
  "results": [...],
  "filter": {...},
  "sort": {...},
  "pagination": {
    "page": 1,
    "perPage": 50,
    "pageCount": 10,
    "resultCount": 487
  }
}

​

Response Fields

• results - Array of result objects
• filter - Applied filter (if any)
• sort - Applied sort configuration
• pagination - Pagination metadata
  • page - Current page number
  • perPage - Results per page
  • pageCount - Total number of pages
  • resultCount - Total number of results matching the query

​

Error Handling

​

HTTP Status Codes

• 200 - Success
• 400 - Bad Request (invalid query, filter, or parameters)
• 401 - Unauthorized (missing or invalid API key)
• 405 - Method Not Allowed (endpoint only supports GET)
• 500 - Internal Server Error

​

Error Response Format

{
  "message": "Error description"
}

​

Common Errors

​

401 Unauthorized - Missing Authorization Header

{
  "message": "Authorization header missing. Please include a valid API key."
}

​

401 Unauthorized - Invalid API Key

{
  "message": "Invalid API key. Please ensure that the API key is correct and try again."
}

​

400 Bad Request - Invalid Filter

{
  "message": "Invalid filter format"
}

​

400 Bad Request - Invalid Query

{
  "message": "Invalid operator 'invalidOp' for field 'market_value_dollar'"
}