Sentiment AnalysisSentiment Analysis API

OnlineCredit Usage:5 per callRefreshed 1 month ago
avg: 1033ms|p50: 940ms|p75: 1095ms|p90: 1281ms|p99: 1653ms

Overview

To use Sentiment Analysis, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/sentimentanalysis

Example

How to call the Sentiment Analysis API in different programming languages.

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/sentimentanalysis" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
}'
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/sentimentanalysis', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
})
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
}

response = requests.post('https://api.apiverve.com/v1/sentimentanalysis', headers=headers, json=payload)

data = response.json()
print(data)
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/sentimentanalysis", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "comparative": 0.25,
    "sentimentText": "positive",
    "sentiment": 3,
    "isPositive": true,
    "isNegative": false,
    "normalizedScore": 0.3
  }
}

Authentication

The Sentiment Analysis API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Sentiment Analysis API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Sentiment Analysis API:

Analyze Sentiment

ParameterTypeRequiredDescriptionDefaultExample
textstringrequired
The text to analyze the sentiment of
-I absolutely love this product! It exceeded all my expectations.

Response

The Sentiment Analysis API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <comparative>0.25</comparative>
    <sentimentText>positive</sentimentText>
    <sentiment>3</sentiment>
    <isPositive>true</isPositive>
    <isNegative>false</isNegative>
    <normalizedScore>0.3</normalizedScore>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  comparative: 0.25
  sentimentText: positive
  sentiment: 3
  isPositive: true
  isNegative: false
  normalizedScore: 0.3
CSV Response
200 OK
keyvalue
comparative0.25
sentimentTextpositive
sentiment3
isPositivetrue
isNegativefalse
normalizedScore0.3

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
comparativenumber0.25
-
sentimentTextstring"positive"
-
sentimentnumber3
-
isPositivebooleantrue
Whether the sentiment is positive
isNegativebooleanfalse
Whether the sentiment is negative
normalizedScorePremiumnumber0.3
Sentiment score normalized to -1 to 1 range

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Sentiment Analysis through GraphQL to combine it with other API calls in a single request. Query only the sentiment analysis data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Sentiment Analysis in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  sentimentanalysis(
    input: {
      text: "I'm so excited that tomorrow is going to be sunny! Can't wait!"
    }
  ) {
    comparative
    sentimentText
    sentiment
    isPositive
    isNegative
    normalizedScore
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Sentiment Analysis API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Sentiment Analysis requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Sentiment Analysis API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Sentiment Analysis

Official Sentiment Analysis packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Sentiment Analysis works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Frequently Asked Questions

How do I get an API key for Sentiment Analysis?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Sentiment Analysis and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Sentiment Analysis cost?

Each successful Sentiment Analysis API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful sentiment analysis lookups.

Can I use Sentiment Analysis in production?

The free plan is for testing and development only. For production use of Sentiment Analysis, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Sentiment Analysis from a browser?
Yes! The Sentiment Analysis API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Sentiment Analysis credit limit?

When you reach your monthly credit limit, Sentiment Analysis API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?