Best Practices

To get the most out of QuillCheck and ensure secure, efficient, and scalable integrations, follow these best practices:

🔒 1. Secure Your API Key

• Keep your API key confidential and never expose it on the client side (e.g., frontend apps, public repositories).

• Use environment variables or secure vaults to store your API key.

• Rotate your API key periodically for enhanced security.

⚡ 2. Optimise API Calls

• Cache frequently requested data (like token info) to reduce API usage and improve performance.

• Avoid redundant requests by checking whether data has changed before making a call.

✅ 3. Validate Input Data

• Always validate input parameters (like token addresses and chain IDs) before making an API request.

• Ensure that addresses are properly checksummed (e.g., using EIP-55).

🧪 4. Handle Errors Properly

• Always check for response status codes.

• Implement error handling for:

  • Invalid API keys (401 Unauthorized)

  • Missing parameters (400 Bad Request)

  • Token not found (404 Not Found)

  • Server errors (5xx)

📋 5. Log and Monitor Usage

• Log API responses and errors to help with debugging and analytics.

• Monitor your API usage to stay within limits and detect unusual activity.

📈 6. Use the Latest Endpoint Version

• Always refer to the API changelog for updates.

• Migrate to the latest versions of endpoints to take advantage of new features and improvements.