VETTR Developer Portal
Build powerful mining stock analysis tools with the VETTR API. Access scores, filings, red flags, and executive data programmatically.
Quick Start
Authentication
The VETTR API uses JWT Bearer tokens for authentication. Follow these steps to get started.
Create an account
Send a POST request to /v1/auth/signup with your email and password.
Get your token
POST to /v1/auth/login with your credentials. You will receive a JWT access token.
Make authenticated requests
Include the token as a Bearer token in the Authorization header. Admin routes require an additional X-Admin-Secret header.
curl -X POST https://vettr-backend.vercel.app/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "dev@example.com", "password": "your-password"}'curl https://vettr-backend.vercel.app/v1/stocks \
-H "Authorization: Bearer YOUR_TOKEN"Rate Limits
API requests are rate-limited based on your subscription tier. Limits are applied per minute using a sliding window.
| Tier | Read Requests | Write Requests |
|---|---|---|
| Free | 60/min | 20/min |
| Pro | 120/min | 60/min |
| Premium | 300/min | 120/min |
API Overview
The VETTR API is organized around REST. All endpoints accept and return JSON. Explore each group below.
Auth
Signup, login, OAuth, and token refresh
Stocks
List, search, get by ticker, and pagination
Filings
Regulatory filings with filtering by type
Executives
Management team data and profiles
VETTR Score
Score calculation, breakdown, and history
Red Flags
Detection, analysis, and severity tracking
Alerts
Custom alert rules and notifications
Watchlist
User watchlist management and tracking
Ready to start building?
Explore the full API documentation and start integrating VETTR data into your applications today.