Snag API
Integrate Snag's REST API into your Web3 app. Authenticate with API keys, configure custom hostnames, and access loyalty, minting, and rewards endpoints.
Using an AI coding assistant? Connect Cursor, Claude, or Copilot to Snag Docs for context-aware help. Learn how.
Please only use the endpoints specified in this document. Using any other endpoints will cause issues with your client.
What You Need
Retrieve your API Key, Currency ID, and Organization ID from the admin dashboard.
Authentication
All API endpoints require authentication using an API key, which must be included in the request headers.
Include your API key in the x-api-key header as shown below:
x-api-key: <YOUR_API_KEY>Base URL
For development and testing purposes, you can use the following base URL:
https://admin.snagsolutions.ioThe development base URL has rate limiting restrictions. For production environments, it's recommended to configure a custom hostname to get better rate limits and improved performance.
Custom Hostname Configuration
You have two options for configuring your production API base URL:
Configure a subdomain on your own domain (e.g., api.yourwebsite.com or loyalty.yourwebsite.com):
- Choose your desired subdomain
- Add a CNAME record pointing to your Snag platform
- Configure the hostname in the admin dashboard
Both custom hostname options provide better rate limits and performance compared to the development base URL. Choose the option that best fits your branding and infrastructure requirements.
Here’s an example of an HTTP request with the API key:
GET /api/v1/your-endpoint HTTP/1.1
Host: api.snag.com
x-api-key: <YOUR_API_KEY>
Content-Type: application/json
{ /* Request body if applicable */ }