# TwitterScore API documentation

The TwitterScore API is a REST API (JSON over HTTPS) that returns the **Twitter Score** of crypto X (Twitter) accounts: a 0 to 1000 score computed from the quality of an account's followers (venture funds, crypto projects, founders, exchanges, influencers), not from follower count. It also returns account info, score and follower history, Smart Followers, trending and Smart Follows lists: the same data as twitterscore.io, recalculated daily.

- **Base URL:** `https://twitterscore.io/api/v1/` (25 endpoints, all `GET`, JSON responses)
- **Authentication:** `X-API-Key: <key>` header. Keys are issued on the [API dashboard](https://twitterscore.io/api-dashboard/) after choosing a plan on the [pricing page](https://twitterscore.io/api/prices) (plans from $49/month, free trial available).
- **Machine-readable:** [OpenAPI 3.1](/openapi.json) ([YAML](/openapi.yaml)), [llms.txt for this documentation](/developers/llms.txt), [API catalog](/.well-known/api-catalog).

## Your first request

```bash
curl -s "https://twitterscore.io/api/v1/get_twitter_score?username=VitalikButerin" \
  -H "X-API-Key: $TWITTERSCORE_API_KEY"
```

```json
{"success": true, "username": "VitalikButerin", "twitter_id": "295218901", "twitter_score": 1000.0}
```

More languages in the [Quickstart](/developers/quickstart/).

## Endpoints

**Scores:** [`bulk_scores_check`](/developers/endpoints/bulk_scores_check/), [`get_twitter_score`](/developers/endpoints/get_twitter_score/), [`get_twitter_scores_diff`](/developers/endpoints/get_twitter_scores_diff/)

**Accounts:** [`get_twitter_info`](/developers/endpoints/get_twitter_info/), [`limits`](/developers/endpoints/limits/)

**Followers:** [`followers_count_history`](/developers/endpoints/followers_count_history/), [`get_categorized_followers_count`](/developers/endpoints/get_categorized_followers_count/), [`get_followers`](/developers/endpoints/get_followers/), [`get_followers_diff`](/developers/endpoints/get_followers_diff/), [`get_followers_score_sum`](/developers/endpoints/get_followers_score_sum/), [`get_tagged_followers_count`](/developers/endpoints/get_tagged_followers_count/), [`get_twitter_top_followers`](/developers/endpoints/get_twitter_top_followers/) (deprecated), [`top_followers_paginate`](/developers/endpoints/top_followers_paginate/) (deprecated)

**Mentions:** [`get_mentioners`](/developers/endpoints/get_mentioners/), [`get_mentions_feed`](/developers/endpoints/get_mentions_feed/), [`get_smart_mentions`](/developers/endpoints/get_smart_mentions/)

**Lists:** [`get_alpha`](/developers/endpoints/get_alpha/) (deprecated), [`get_smart_follows`](/developers/endpoints/get_smart_follows/), [`get_tokenless`](/developers/endpoints/get_tokenless/), [`get_top_researched`](/developers/endpoints/get_top_researched/), [`get_trending`](/developers/endpoints/get_trending/)

**History:** [`friendshipHistory/followed`](/developers/endpoints/friendshipHistory_followed/), [`friendshipHistory/following`](/developers/endpoints/friendshipHistory_following/)

**Reference:** [`get_categories`](/developers/endpoints/get_categories/), [`get_tags`](/developers/endpoints/get_tags/)

Full list with parameters: [Endpoints](/developers/endpoints/).

## Good to know

- Errors are JSON with `success: false`, a `message` and an `error.code`; see [Errors](/developers/errors/) for the transitional HTTP-status behaviour.
- Limits are a per-minute rate and a 30-day quota per plan; `GET https://twitterscore.io/api/v1/limits` shows what is left. See [Rate limits](/developers/rate-limits/).
- Scores, ranks and Smart Followers are recalculated daily. When you publish numbers, cite "TwitterScore (twitterscore.io)" and the date.
- Building an agent or a tool? See [Connect agents](/developers/connect/).