# API Documentation

## Omira API Documentation

{% hint style="info" %}
Base URL: `redacted.app/api/...`
{% endhint %}

## Authentication

Include your API key in the URL path. Example: `https://accesspoint.app/api/{api_key}/...`

## Endpoints

{% hint style="info" %}
URL: `.../token-sentiment/{model}/{network}/{contract_address}`

#### Method: GET

{% endhint %}

#### Path Parameters

* `model`: Sentiment analysis model to use. 
  * Options: `sent`
* `network`: Blockchain network. 
  * Options: `eth`, `bsc`, `sol`

#### Response 

`sentiment_report`: Our model's report on the requested token's sentiment.

***

## Price Predictions

{% hint style="info" %}
URL: `.../token-prediction/{model}/{network}/{contract_address}`

#### Method: GET

{% endhint %}

### Path Parameters

* `model`: Price prediction model. 
  * Options: `bb4`, `bb4dL`
* `network`: Blockchain network. 
  * Options: `eth`, `bsc`, `sol`
* `contract_address`: Token contract address

### Responses (bb4/bb4dL):

* `predicted_price`: 
  * `12h/1d`
  * `24h/3d`
  * `48h/5d`

***

## Error Responses

* 400 Bad Request: Invalid request parameters
* 401 Unauthorized: Invalid or missing API key
* 404 Not Found: Requested resource not found
* 500 Internal Server Error: Server-side error occurred

### Rate Limits

The API is rate-limited to prevent abuse. Exceeding the limit will return a 429 Too Many Requests error. Contact us for higher limits.