Griffy API Documentation
Build powerful applications with Griffy's comprehensive API. Access real-time risk analysis, token metrics, and blockchain data for Solana tokens.
Get Started: Sign up for an API key to begin integrating with our platform.
API Features
- Real-time risk assessment for Solana tokens
- Comprehensive token metrics and analytics
- Historical data with customizable timeframes
- Holder distribution and concentration analysis
- Liquidity pool metrics and health indicators
- Developer-friendly RESTful API with JSON responses
Base URL
Response Format
All API responses are in JSON format and include a standard response object:
Authentication
All API requests require authentication using API keys. You can generate and manage your API keys in the Developer Dashboard.
Using Your API Key
Include your API key in the Authorization header of all requests:
Security Note: Never expose your API keys in client-side code. Keep them secure using environment variables or secret management systems.
Key Types
Key Type | Permissions | Rate Limit | Environment |
---|---|---|---|
Test Key | Read-only, limited data | 10 req/min | Development |
Production Key | Full access | 60 req/min | Production |
Partner Key | Extended access, higher limits | 120 req/min | Production |
Rate Limiting
To ensure fair usage and system stability, all API endpoints have rate limits based on your API key type.
Rate Limit Headers
Each API response includes headers showing your current rate limit status:
Handling Rate Limits
If you exceed your rate limit, you will receive a 429 status code. Implement exponential backoff in your application to handle these cases gracefully.
Risk Analysis Endpoint
Get comprehensive risk assessment for any Solana token. This endpoint analyzes multiple risk factors and returns a detailed risk profile.
Path Parameters
Parameter | Type | Description | Required |
---|---|---|---|
token_address | string | Solana token address (base58 encoded) | Yes |
Query Parameters
Parameter | Type | Description | Required |
---|---|---|---|
timeframe | string | Analysis timeframe (1h, 24h, 7d, 30d) | No |
include_historical | boolean | Include historical risk scores | No |
detailed | boolean | Return detailed breakdown of risk factors | No |
Example Request
Response Example
SDKs & Libraries
Accelerate your integration with our official SDKs and community libraries:
Official SDKs
- JavaScript SDK - Full browser and Node.js support
- Python SDK - For data analysis and backend services
- Java SDK - Enterprise-grade integration
Community Libraries
- Go - griffy-go by community member
- Ruby - griffy-ruby gem
- PHP - Griffy-PHP package
- .NET - Griffy.NET library
Contribute: Build your own library? Share it with the community and get featured here.
Error Codes
The Griffy API uses standard HTTP status codes and provides detailed error messages in responses.
Error Response Format
Common Error Codes
HTTP Code | Error Code | Description | Solution |
---|---|---|---|
400 | invalid_parameter | Invalid or missing parameter | Check request parameters |
401 | invalid_api_key | Invalid or missing API key | Verify your API key |
403 | access_denied | Insufficient permissions | Upgrade your API plan |
404 | token_not_found | Token address not recognized | Verify token address |
429 | rate_limit_exceeded | Too many requests | Check rate limit headers |
500 | server_error | Internal server error | Retry later or contact support |
Best Practices
Follow these recommendations to build robust integrations with the Griffy API:
Never commit API keys to version control. Use environment variables or secret management systems.
Cache responses where appropriate to reduce requests and improve performance.
Use exponential backoff and respect Retry-After headers when rate limited.
For critical data changes, use our webhook system instead of polling.
Track your API usage to avoid rate limits and optimize costs.
Webhook Integration
Receive real-time notifications for risk level changes, liquidity events, and other important token activities.
Production Tip: Always verify webhook signatures to ensure they come from Griffy.