WatchDogs NFT Marketplace

WATCHDOGS NFT Marketplace

📚 WatchDogs Docs

v0.4

Ctrl+K

📖 Documentation

🔌 API Reference

Complete API documentation for integrating with the WatchDogs platform

Overview

The WatchDogs API provides programmatic access to all platform features including NFT marketplace data, staking information, token analytics, and AI agent interactions. Our RESTful API is designed for easy integration and comprehensive functionality.

RESTful API

Secure & Authenticated

Real-time Data

Authentication

Bearer token authentication is required only for POST endpoints (AI chat & analysis). All GET endpoints are now public and can be accessed without authentication. You must own at least 1 WatchDogs NFT OR stake a minimum of 133,133 WATCH tokens to generate a Bearer token.

POST Endpoints Only

Bearer token is required only for AI-powered endpoints (/api/chat, /api/risk-analysis). Generate your token at /docs/api-swagger.

Token Generation Requirements:

Own 1+ WatchDogs NFT
OR stake 133,133+ WATCH tokens
Token expires after 30 days

Authorization Header Format:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Rate Limits

API endpoints have rate limits to ensure fair usage and prevent abuse. Limits are applied per IP address.

Endpoint	Method	Rate Limit	Category
/api/chat	POST	10 requests/minute	AI Chat
/api/risk-analysis	POST	5 requests/minute	AI Analysis
/api/staking-stats	GET	30 requests/minute	Staking
/api/tvl-analytics	GET	30 requests/minute	Analytics
/api/analyzed-token-data	GET	20 requests/minute	Token Data
/api/collection-stats	GET	50 requests/minute	NFT Collections
/api/nft-owner	GET	50 requests/minute	NFT Collections
/api/collections	GET	50 requests/minute	NFT Collections
/collections_metadata/{address}.json	GET	50 requests/minute	NFT Collections

Rate Limit Headers

API responses include headers showing your current rate limit status: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Authentication

Most endpoints are publicly accessible, but some require specific access controls or API keys.

Public Endpoints

/api/staking-stats
/api/tvl-analytics
/api/analyzed-token-data
/api/collection-stats
/api/nft-owner
/api/collections
/collections_metadata/{address}.json

API Key Required

/api/chat (OpenAI API key required)
/api/risk-analysis (OpenAI API key required)

OpenAI API Key Required

AI endpoints (/api/chat, /api/risk-analysis) require a valid OpenAI API key to be provided in the request body. Get your API key from OpenAI Platform.

Core Endpoints

Authentication

Bearer token is required only for POST endpoints (AI chat & analysis). All GET endpoints are now public and work directly in browser.

AI Chat & Analysis

AI-powered chat and token analysis endpoints.

POST /api/chat

POST /api/risk-analysis

Staking & Analytics

Staking statistics and TVL analytics.

GET /api/staking-stats

GET /api/tvl-analytics

Token Data

Market data for discovered tokens with AI analysis.

GET /api/analyzed-token-data

NFT Collections

NFT collection metadata and information.

GET /collections_metadata/{address}.json

GET /api/collection-stats

GET /api/nft-owner

GET /api/collections

Code Examples

Authentication Requirements

Bearer token is required only for POST endpoints (AI chat & analysis). GET endpoints are public and don't require authentication. Token format: "Bearer YOUR_TOKEN" (note the space).

AI Chat

Test this endpoint:

curl -X POST https://watchdogs.ink/api/chat \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN" \
  -d '{
    "message": "Tell me about this collection",
    "collectionId": "watchdogs",
    "conversationHistory": [],
    "openaiApiKey": "sk-your-openai-api-key-here"
  }'

Invoke-WebRequest -Uri "https://watchdogs.ink/api/chat" -Method POST \
  -Headers @{"Content-Type"="application/json"; "Authorization"="Bearer YOUR_BEARER_TOKEN"} \
  -Body '{
    "message": "Tell me about this collection",
    "collectionId": "watchdogs",
    "conversationHistory": [],
    "openaiApiKey": "sk-your-openai-api-key-here"
  }'

Token Risk Analysis

Test this endpoint:

curl -X POST https://watchdogs.ink/api/risk-analysis \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN" \
  -d '{
    "tokenData": {
      "contractAddress": "0x53EB0098d09B8d1008f382BbD2A5D4f649111710"
    },
    "openaiApiKey": "sk-your-openai-api-key-here"
  }'

Invoke-WebRequest -Uri "https://watchdogs.ink/api/risk-analysis" -Method POST \
  -Headers @{"Content-Type"="application/json"; "Authorization"="Bearer YOUR_BEARER_TOKEN"} \
  -Body '{
    "tokenData": {
      "contractAddress": "0x53EB0098d09B8d1008f382BbD2A5D4f649111710"
    },
    "openaiApiKey": "sk-your-openai-api-key-here"
  }'

Staking Statistics

curl -X GET "https://watchdogs.ink/api/staking-stats"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/staking-stats" -Method GET

TVL Analytics

curl -X GET "https://watchdogs.ink/api/tvl-analytics?timeframe=all&includeAllHistory=true"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/tvl-analytics?timeframe=all&includeAllHistory=true" -Method GET

Analyzed Token Data

curl -X GET "https://watchdogs.ink/api/analyzed-token-data?sortBy=volume24h&order=desc&limit=10"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/analyzed-token-data?sortBy=volume24h&order=desc&limit=10" -Method GET

Collection Metadata

curl -X GET "https://watchdogs.ink/collections_metadata/0x58da2f96c473e9cb89f0de7c6f1faede70d47c93.json"

Invoke-WebRequest -Uri "https://watchdogs.ink/collections_metadata/0x58da2f96c473e9cb89f0de7c6f1faede70d47c93.json" -Method GET

Collection Statistics

curl -X GET "https://watchdogs.ink/api/collection-stats?address=0x58da2f96c473e9cb89f0de7c6f1faede70d47c93"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/collection-stats?address=0x58da2f96c473e9cb89f0de7c6f1faede70d47c93" -Method GET

NFT Owner Information

curl -X GET "https://watchdogs.ink/api/nft-owner?address=0x58da2f96c473e9cb89f0de7c6f1faede70d47c93&tokenId=1"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/nft-owner?address=0x58da2f96c473e9cb89f0de7c6f1faede70d47c93&tokenId=1" -Method GET

Available Collections

curl -X GET "https://watchdogs.ink/api/collections"

Invoke-WebRequest -Uri "https://watchdogs.ink/api/collections" -Method GET

Response Examples

Risk Analysis Response

{
  "riskScore": 45,
  "riskLevel": "MODERATE",
  "analysis": "WATCHDOGS (WATCH) presents a moderate level of risk...",
  "keyFactors": ["Factor 1", "Factor 2", "Factor 3"],
  "socialSentiment": "Positive community sentiment",
  "recommendation": "Proceed with caution",
  "redFlags": [
    {
      "flag": "Low liquidity",
      "severity": "moderate"
    }
  ],
  "analyzedAt": "2024-01-15T10:30:00.000Z"
}

TVL Analytics Response

{
  "analytics": {
    "currentTVL": 6000.68,
    "totalStaked": 54900980.29,
    "totalUnstaked": 48900980.29,
    "netStaked": 6000000,
    "totalTransactions": 630,
    "stakeTransactions": 315,
    "unstakeTransactions": 315,
    "averageStakeAmount": 174288.83,
    "averageUnstakeAmount": 155241.21,
    "tokenPrice": 0.000123,
    "dataSource": "blockchain"
  },
  "data": [
    {
      "timestamp": 1741718187000,
      "value": 6000.68,
      "tokensAmount": 50000980.30,
      "description": "+50000980.30 WATCH from 0x5A30...c544",
      "type": "stake"
    }
  ],
  "filters": {
    "type": "all",
    "timeframe": "all",
    "includeAllHistory": true
  }
}

Collection Stats Response

{
  "contractAddress": "0x58da2f96c473e9cb89f0de7c6f1faede70d47c93",
  "collectionName": "WatchDogs",
  "collectionSymbol": "WATCH",
  "totalSupply": 133,
  "holders": 24,
  "uniqueOwners": 24,
  "totalTokens": 133,
  "floorPrice": 0.5,
  "averagePrice": 0.75,
  "listedTokens": 15,
  "lastUpdated": "2024-01-15T10:30:00.000Z"
}

Support

Need help with the API? Here are the best ways to get support and stay updated.

Community Support

Telegram community discussions
GitHub issues and discussions
Community forums and Q&A
Peer-to-peer assistance

Documentation

API reference documentation
Code examples and tutorials
Integration guides
Best practices and tips

Getting Help

For technical issues, please check the documentation first and then reach out to the community. Include relevant error messages and request details when asking for help.

Interactive API Explorer

Test all endpoints directly in your browser with our Swagger UI interface. No setup required!

CA: 0x53EB...1710

Risk Disclosure & Terms