API Documentation
Integrate financial sentiment analysis into your applications
The Concept
SentimentWiki provides asset-specific sentiment analysis. Unlike generic sentiment models, our API understands context โ "OPEC cuts production" is bullish for oil but might be bearish for airlines.
# The dream API
sentiment = sentiment_of("OPEC announces surprise production cut", security="OIL")
# โ { direction: "BULLISH", magnitude: 0.85, relevance: 0.95 }
POST /v1/analyze
Analyze sentiment of text for a specific security.
Request
POST https://sentimentwiki.io/v1/analyze
Content-Type: application/json
{
"text": "OPEC announces surprise production cut of 1M bpd",
"security": "OIL"
}
Response
{
"direction": "BULLISH",
"magnitude": 0.85,
"relevance": 0.95,
"reasoning": "Production cuts reduce supply, typically bullish for oil prices",
"model_version": "oil-v1.2",
"latency_ms": 142
}
cURL Example
curl -X POST https://sentimentwiki.io/v1/analyze \
-H "Content-Type: application/json" \
-d '{"text": "Fed signals rate pause", "security": "SPY"}'
Interactive Documentation
Full API reference with try-it-out functionality is available at /docs (Swagger UI) or /redoc (ReDoc).
Rate Limits
| Tier | Requests/min | Price |
|---|---|---|
| Free | 10 | $0 |
| Contributor | 100 | Free (500+ labels) |
| Pro | 1000 | Coming soon |