# Quick Start Guide

Get started with the CSDS API in 5 minutes.

## Overview

The Crypto Scam Detection System (CSDS) API provides real-time risk analysis for cryptocurrency tokens across multiple blockchains. This guide will help you make your first API request.

## Basic Request

### Endpoint
```
POST /api/check
```

### Request Format
```json
{
  "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "blockchain": "ethereum",
  "note": "Optional user note"
}
```

### Example with cURL
```bash
curl -X POST https://csds.blockchainrangers.com/api/check \
  -H "Content-Type: application/json" \
  -d '{
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "blockchain": "ethereum"
  }'
```

### Response Format
```json
{
  "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "blockchain": "ethereum",
  "risk_score": 68,
  "status": "Moderate Risk",
  "risk_factors": {
    "contract_verified": true,
    "verification_risk": 0,
    "metadata_completeness": 80,
    "supply_risk": 5,
    "blockchain_risk": 5
  },
  "token_data": {
    "name": "Example Token",
    "symbol": "EXT",
    "decimals": 18,
    "total_supply": "1000000000",
    "is_verified": true
  },
  "cached": false
}
```

## Understanding Risk Scores

| Score | Status | Meaning |
|-------|--------|---------|
| 0-25 | Low Risk | Token appears legitimate with strong fundamentals |
| 26-50 | Moderate Risk | Some concerns exist, proceed with caution |
| 51-75 | High Risk | Multiple red flags present, high risk |
| 76-100 | Critical Risk | Strong scam indicators, avoid |

## Supported Blockchains

- **Ethereum**: `ethereum`
- **Solana**: `solana`
- **BNB Chain**: `bnb`
- **TON**: `ton`

See [all chains](/docs/chains) for complete list.

## Rate Limiting

- **Free tier**: 100 requests per hour per IP
- **Premium tier**: Unlimited requests with AI-enhanced analysis

## Next Steps

- [View code examples](/docs/examples/python) in Python, JavaScript, cURL
- [Understand risk factors](/docs/methodology/scoring) in detail
- [Browse analyzed tokens](/tokens) - 47,000+ tokens indexed
- [Read AI integration guide](/AGENTS.md) for LLM/agent integration

## Common Issues

### Invalid Address Format
**Error**: "Invalid contract address format"
**Solution**: Ensure address matches blockchain format:
- Ethereum/BNB: `0x` + 40 hex characters
- Solana: 32-44 base58 characters
- TON: 48 base64url characters

### Token Not Found
**Error**: "Token not found on blockchain"
**Solution**: Verify the address exists on the specified blockchain using block explorer

### Rate Limit Exceeded
**Error**: 429 Too Many Requests
**Solution**: Wait and retry, or upgrade to premium tier

## Support

- [Full API Reference](/docs/api-reference)
- [Common Use Cases](/docs/use-cases)
- [AGENTS.md](/AGENTS.md) - For AI agents and LLMs