# Arbus API Docs

### Endpoints

#### Health Check

## Check API health and authentication

<mark style="color:blue;">`GET`</mark> `https://api.arbus.ai/v1/health`

Simple health check to verify API availability and validate your API key.

#### Query Parameters

| Name                                  | Type   | Description  |
| ------------------------------------- | ------ | ------------ |
| key<mark style="color:red;">\*</mark> | string | Your API key |

{% tabs %}
{% tab title="200: OK API is healthy" %}

```json
{
  "status": "healthy",
  "timestamp": "2025-06-25T15:30:00Z",
  "service": "Arbus AI Crypto Analysis API"
}
```

{% endtab %}
{% endtabs %}

***

#### Get Arbus Score

## Get Arbus Score for a Twitter account

<mark style="color:blue;">`GET`</mark> `https://api.arbus.ai/v1/arbus-score`

Returns the Arbus Score - a numerical rating of crypto market influence for any Twitter account.

#### Query Parameters

| Name                                              | Type   | Description                  |
| ------------------------------------------------- | ------ | ---------------------------- |
| key<mark style="color:red;">\*</mark>             | string | Your API key                 |
| twitter\_handle<mark style="color:red;">\*</mark> | string | Twitter username (without @) |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "twitter_handle": "elonmusk",
  "arbus_score": 6241.68,
  "status": "ok"
}
```

{% endtab %}
{% endtabs %}

***

#### Smart Followers

## Get top 5 most influential followers

<mark style="color:blue;">`GET`</mark> `https://api.arbus.ai/v1/smart-followers`

Shows the top 5 most influential people following a Twitter account based on their Arbus Scores.

#### Query Parameters

| Name                                              | Type   | Description                  |
| ------------------------------------------------- | ------ | ---------------------------- |
| key<mark style="color:red;">\*</mark>             | string | Your API key                 |
| twitter\_handle<mark style="color:red;">\*</mark> | string | Twitter username (without @) |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "twitter_handle": "elonmusk",
  "top5_smart_followers": [
    {
      "username": "blknoiz06",
      "follower_count": 245000,
      "influence_score": 6021.57
    },
    {
      "username": "VitalikButerin",
      "follower_count": 5200000,
      "influence_score": 5880.26
    }
  ],
  "status": "ok"
}
```

{% endtab %}
{% endtabs %}

***

#### Mindshare Metrics

## Get mindshare analytics across time periods

<mark style="color:blue;">`GET`</mark> `https://api.arbus.ai/v1/mindshare-metrics`

Provides detailed mindshare analytics across different time periods (1hr, 3hr, 6hr, 12hr, 24hr, 7d, 30d, 3mo).

#### Query Parameters

| Name                                              | Type   | Description                  |
| ------------------------------------------------- | ------ | ---------------------------- |
| key<mark style="color:red;">\*</mark>             | string | Your API key                 |
| twitter\_handle<mark style="color:red;">\*</mark> | string | Twitter username (without @) |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "twitter_handle": "elonmusk",
  "arbus_mindshare_last1hour_coverage": 2.1,
  "arbus_mindshare_1hour_percentage_change": 5.2,
  "arbus_mindshare_last3hours_coverage": 8.4,
  "arbus_mindshare_3hours_percentage_change": 12.1,
  "arbus_mindshare_last24hours_coverage": 15.8,
  "arbus_mindshare_24hours_percentage_change": 12.5,
  "arbus_mindshare_last7days_coverage": 22.3,
  "arbus_mindshare_7days_percentage_change": -3.1,
  "arbus_mindshare_last30days_coverage": 31.2,
  "arbus_mindshare_30days_percentage_change": 8.7,
  "status": "ok"
}
```

{% endtab %}
{% endtabs %}

***

#### AI Assistant

## Ask AI assistant for market analysis

<mark style="color:green;">`POST`</mark> `https://api.arbus.ai/v1/ask-ai-assistant`

Ask any question about crypto markets and get AI-powered analysis based on real-time data.

#### Query Parameters

| Name                                  | Type   | Description  |
| ------------------------------------- | ------ | ------------ |
| key<mark style="color:red;">\*</mark> | string | Your API key |

#### Request Body

| Name                                    | Type    | Description                                 |
| --------------------------------------- | ------- | ------------------------------------------- |
| query<mark style="color:red;">\*</mark> | string  | Your question about crypto markets          |
| days                                    | integer | Days of data to analyze (1-365, default: 7) |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "query": "Is Bitcoin bullish right now?",
  "days": 3,
  "response": "Bitcoin sentiment is mixed with cautious optimism. Technical indicators show...",
  "timestamp": "2025-06-25T15:30:45.123456"
}
```

{% endtab %}
{% endtabs %}

***

#### Project Analysis

## Get comprehensive project analysis

<mark style="color:green;">`POST`</mark> `https://api.arbus.ai/v1/assistant-summary`

Get comprehensive AI analysis of specific crypto projects with bullish/bearish scenarios.

#### Query Parameters

| Name                                  | Type   | Description  |
| ------------------------------------- | ------ | ------------ |
| key<mark style="color:red;">\*</mark> | string | Your API key |

#### Request Body

| Name                                                        | Type    | Description                                                         |
| ----------------------------------------------------------- | ------- | ------------------------------------------------------------------- |
| ticker\_or\_twitterhandle<mark style="color:red;">\*</mark> | string  | Project name or Twitter handle (e.g., "Ethereum", "BTC", "vitalik") |
| day\_interval                                               | integer | Days to analyze (1-30, default: 7)                                  |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "ticker_or_twitterhandle": "Solana",
  "response_arbus_ai_assistant": "Solana shows strong momentum with Firedancer upgrade, institutional interest from BlackRock..."
}
```

{% endtab %}
{% endtabs %}

***

#### Reports

## Generate structured project reports

<mark style="color:green;">`POST`</mark> `https://api.arbus.ai/v1/report`

Generate structured reports for crypto projects with categorized findings.

#### Query Parameters

| Name                                  | Type   | Description  |
| ------------------------------------- | ------ | ------------ |
| key<mark style="color:red;">\*</mark> | string | Your API key |

#### Request Body

| Name                                              | Type   | Description                                          |
| ------------------------------------------------- | ------ | ---------------------------------------------------- |
| twitter\_handle<mark style="color:red;">\*</mark> | string | Project's Twitter handle                             |
| category<mark style="color:red;">\*</mark>        | string | Report category: `projects`, `threador`, or `alerts` |
| date\_from                                        | string | Start date (YYYY-MM-DD format)                       |
| date\_to                                          | string | End date (YYYY-MM-DD format)                         |

{% tabs %}
{% tab title="200: OK Success" %}

```json
{
  "summary": {
    "Partnerships & Collaborations": ["Partnership with Binance announced"],
    "Product Development": ["New DeFi protocol launched"],
    "Exchange Listings": ["Listed on Coinbase"]
  }
}
```

{% endtab %}
{% endtabs %}

***

### Code Examples

#### GET Requests (Query Parameters)

{% tabs %}
{% tab title="cURL" %}

```bash
# Health Check
curl "https://api.arbus.ai/v1/health?key=YOUR_API_KEY"

# Get Arbus Score
curl "https://api.arbus.ai/v1/arbus-score?twitter_handle=elonmusk&key=YOUR_API_KEY"

# Smart Followers
curl "https://api.arbus.ai/v1/smart-followers?twitter_handle=elonmusk&key=YOUR_API_KEY"

# Mindshare Metrics
curl "https://api.arbus.ai/v1/mindshare-metrics?twitter_handle=elonmusk&key=YOUR_API_KEY"
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
// GET requests
const baseUrl = 'https://api.arbus.ai/v1';
const apiKey = 'YOUR_API_KEY';

const getArbusScore = async (twitterHandle) => {
  const response = await fetch(`${baseUrl}/arbus-score?twitter_handle=${twitterHandle}&key=${apiKey}`);
  return await response.json();
};

const getSmartFollowers = async (twitterHandle) => {
  const response = await fetch(`${baseUrl}/smart-followers?twitter_handle=${twitterHandle}&key=${apiKey}`);
  return await response.json();
};

const getMindshareMetrics = async (twitterHandle) => {
  const response = await fetch(`${baseUrl}/mindshare-metrics?twitter_handle=${twitterHandle}&key=${apiKey}`);
  return await response.json();
};
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

base_url = 'https://api.arbus.ai/v1'
api_key = 'YOUR_API_KEY'

def get_arbus_score(twitter_handle):
    response = requests.get(f'{base_url}/arbus-score', params={
        'twitter_handle': twitter_handle,
        'key': api_key
    })
    return response.json()

def get_smart_followers(twitter_handle):
    response = requests.get(f'{base_url}/smart-followers', params={
        'twitter_handle': twitter_handle,
        'key': api_key
    })
    return response.json()

def get_mindshare_metrics(twitter_handle):
    response = requests.get(f'{base_url}/mindshare-metrics', params={
        'twitter_handle': twitter_handle,
        'key': api_key
    })
    return response.json()
```

{% endtab %}
{% endtabs %}

#### POST Requests (JSON Body)

{% tabs %}
{% tab title="cURL" %}

```bash
# AI Assistant
curl -X POST "https://api.arbus.ai/v1/ask-ai-assistant?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "Is Bitcoin bullish?", "days": 7}'

# Project Analysis
curl -X POST "https://api.arbus.ai/v1/assistant-summary?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticker_or_twitterhandle": "Ethereum", "day_interval": 7}'

# Reports
curl -X POST "https://api.arbus.ai/v1/report?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"twitter_handle": "ethereum", "category": "projects"}'
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
// POST requests
const baseUrl = 'https://api.arbus.ai/v1';
const apiKey = 'YOUR_API_KEY';

const askAI = async (query, days = 7) => {
  const response = await fetch(`${baseUrl}/ask-ai-assistant?key=${apiKey}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ query, days })
  });
  return await response.json();
};

const getProjectAnalysis = async (project, dayInterval = 7) => {
  const response = await fetch(`${baseUrl}/assistant-summary?key=${apiKey}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ ticker_or_twitterhandle: project, day_interval: dayInterval })
  });
  return await response.json();
};

const generateReport = async (twitterHandle, category) => {
  const response = await fetch(`${baseUrl}/report?key=${apiKey}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ twitter_handle: twitterHandle, category })
  });
  return await response.json();
};
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

base_url = 'https://api.arbus.ai/v1'
api_key = 'YOUR_API_KEY'

def ask_ai(query, days=7):
    response = requests.post(f'{base_url}/ask-ai-assistant', params={'key': api_key}, json={
        'query': query,
        'days': days
    })
    return response.json()

def get_project_analysis(project, day_interval=7):
    response = requests.post(f'{base_url}/assistant-summary', params={'key': api_key}, json={
        'ticker_or_twitterhandle': project,
        'day_interval': day_interval
    })
    return response.json()

def generate_report(twitter_handle, category):
    response = requests.post(f'{base_url}/report', params={'key': api_key}, json={
        'twitter_handle': twitter_handle,
        'category': category
    })
    return response.json()
```

{% endtab %}
{% endtabs %}

***

### Error Handling

{% tabs %}
{% tab title="401 Unauthorized" %}

```json
{
  "error": "PERMISSION_DENIED: The API targeted by this request is invalid for the given API key.",
  "code": 401
}
```

{% endtab %}

{% tab title="429 Rate Limited" %}

```json
{
  "error": "Rate limit exceeded",
  "code": 429
}
```

{% endtab %}

{% tab title="404 Not Found" %}

```json
{
  "error": "No arbus score found for screen_name: unknown_user",
  "status": "not_found"
}
```

{% endtab %}
{% endtabs %}

***

### Support

* **Email:** <team@arbus.ai>
* **Website:** [arbus.ai](https://arbus.ai)

{% hint style="success" %}
**Need help?** Contact our support team for assistance with API integration.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.arbus.ai/arbus-api-docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.