> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snagsolutions.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 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](/ai-coding-assistant).
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:
```http theme={null}
x-api-key:
```
## Base URL
For development and testing purposes, you can use the following base URL:
```http theme={null}
https://admin.snagsolutions.io
```
The 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`):
1. Choose your desired subdomain
2. Add a CNAME record pointing to your Snag platform
3. Configure the hostname in the admin dashboard
Detailed instructions for configuring CNAME records and hostname setup.
Use a subdomain of `snag-render.com` unique to your website/instance (e.g., `yourbrand.snag-render.com`):
* This option is available directly from the hostname configuration page in admin
* Provides a professional, branded URL without requiring your own domain
* Includes the same benefits as custom hostname configuration
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.
Learn about rate limits for different hostname configurations and best practices for avoiding rate limit issues.
Here’s an example of an HTTP request with the API key:
```http theme={null}
GET /api/v1/your-endpoint HTTP/1.1
Host: api.snag.com
x-api-key:
Content-Type: application/json
{ /* Request body if applicable */ }
```
## Related pages
TypeScript SDK for type-safe access to Snag APIs.
Understand rate limiting and hostname-based limits.
Configure reward programs and automate incentives.
Set up wallet, email, and social login for your platform.