Rate Limiting
While we don’t publish specific rate limits, we do monitor API usage to ensure fair access for all users. If you’re planning to make a large number of requests, please contact us at [email protected] to discuss your needs.Error Handling
The API returns standard HTTP status codes to indicate success or failure:- 200 OK: The request was successful
- 400 Bad Request: The request was invalid or improperly formatted
- 401 Unauthorized: Authentication failed (invalid or missing API key)
- 404 Not Found: The requested resource was not found
- 500 Internal Server Error: An unexpected error occurred on the server
error
field with a description of what went wrong:
Pagination
For endpoints that return multiple items (like/products
), we use offset-based pagination:
- offset: Number of items to skip (default: 0)
- limit: Maximum number of items to return (default: 10, max: 100)
Handling Spot Prices
Spot prices for precious metals can change rapidly. When displaying spot prices to users, consider:- Showing the timestamp (
updatedAt
) to indicate when the price was last updated - Implementing a refresh mechanism to fetch updated prices periodically
- Displaying the market status (
marketOpen
) to indicate if the market is currently active
Working with Product Data
When working with product data, keep in mind:- Products may have multiple variants with different pricing
- The
highestOffer
andlowestListing
fields represent the current market state and may be null if no offers/listings exist - Premium calculations can vary by product subcategory (check the
premiumCalculationType
field)
Testing
We recommend testing your integration thoroughly before deploying to production. Use the following approach:- Start with the
/protected
endpoint to verify authentication - Test with a small subset of products before implementing full integration
- Implement proper error handling for all API calls
- Consider implementing retry logic for transient errors