Howdy Moody Documentation

Comprehensive guides, API references, and examples to help you integrate sentiment analysis into your applications.

Beginner Friendly

Updated 2 days ago

Getting Started with Howdy Moody

Learn how to integrate Howdy Moody's sentiment analysis into your applications in just a few minutes.

1Installation

Install the Howdy Moody SDK using your preferred package manager:

# Using npm
npm install @howdy-moody/sdk

# Using yarn
yarn add @howdy-moody/sdk

# Using pnpm
pnpm add @howdy-moody/sdk

2Authentication

To use the Howdy Moody API, you'll need an API key. You can obtain one by signing up on our developer portal.

Security Note

Never expose your API key in client-side code. Always use environment variables or a secure backend to store and access your API key.

Environment Variables (.env)

HOWDY_MOODY_API_KEY=your_api_key_here

3Basic Usage

Here's a simple example of how to use the Howdy Moody SDK to analyze sentiment:

// Initialize the Howdy Moody SDK
import { HowdyMoody } from '@howdy-moody/sdk';

const client = new HowdyMoody({
  apiKey: 'your-api-key',
  version: 'v1'
});

// Get real-time sentiment analysis
async function getSentiment() {
  try {
    const result = await client.sentiment.analyze({
      platform: 'twitter',
      query: '#bitcoin',
      timeframe: '24h'
    });
    
    console.log(`Overall sentiment: ${result.score}`);
    console.log(`Positive: ${result.positive}%`);
    console.log(`Negative: ${result.negative}%`);
    console.log(`Neutral: ${result.neutral}%`);
    
    return result;
  } catch (error) {
    console.error('Error analyzing sentiment:', error);
  }
}

Response Format

The API returns sentiment scores ranging from -1 (extremely negative) to 1 (extremely positive), along with percentage breakdowns of positive, negative, and neutral sentiments.

Example Response

{
  "status": "success",
  "data": {
    "score": 0.65,
    "positive": 72,
    "negative": 12,
    "neutral": 16,
    "volume": 1458,
    "trending_keywords": ["moon", "bullish", "hodl", "btc", "eth"],
    "timestamp": "2023-08-15T14:28:43Z"
  }
}