Error Handling

Managing and understanding API errors

The Arcsec API is designed to provide clear and helpful error messages to assist in troubleshooting and debugging. Here are some common scenarios where you might encounter errors:

Common Error Scenarios

  • Missing required parameters (e.g., dbId, query, walletAddress, apiKey)
  • Invalid database ID or wrong API key
  • Database not found
  • SQL query errors (syntax errors, etc.)
  • IPFS-related errors

Error Response Format

When an error occurs, the API will return a JSON response with an error field containing a descriptive message:

{
"error": "Error message describing what went wrong"
}

Example Error Messages

  • Missing required parameters
  • Invalid database ID
  • Wrong API key
  • Database not found
  • SQL query error: syntax error
  • IPFS-related error: file upload failed

These error messages are designed to be clear and helpful, guiding you in identifying and resolving the issues in your requests.

Query Process
Understanding the behind-the-scenes flow of API-based database queries
API Routes Examples
Example API routes using Arcsec's API endpoint for common database operations.