Metadata-Version: 2.4
Name: sharpe_api
Version: 1.0.0
Summary: Sharpe API
Home-page: 
Author: Sharpe API Support
Author-email: Sharpe API Support <support@sharpe.ai>
Project-URL: Homepage, https://www.sharpe.ai
Project-URL: Repository, https://github.com/sharpe-labs/sharpe-terminal-v2
Project-URL: Documentation, https://www.sharpe.ai/docs
Keywords: OpenAPI,OpenAPI-Generator,Sharpe API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# sharpe-api
Institutional-grade crypto market data API. Access funding rates, futures, options, arbitrage opportunities, narratives, ecosystems, and more.

Authentication is supported via three methods:
1. **Bearer token** in the Authorization header: `Authorization: Bearer sk_...`
2. **X-API-Key header**: `X-API-Key: sk_...`
3. **Query parameter**: `?api_key=sk_...` (useful for webhooks, browser links, and environments where setting headers is not possible)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://sharpe.ai](https://sharpe.ai)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import sharpe_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import sharpe_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import sharpe_api
from sharpe_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sharpe.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = sharpe_api.Configuration(
    host = "https://api.sharpe.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization: BearerAuth
configuration = sharpe_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sharpe_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sharpe_api.AccountApi(api_client)

    try:
        # API usage and quota
        api_response = api_instance.get_usage()
        print("The response of AccountApi->get_usage:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_usage: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.sharpe.ai*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**get_usage**](docs/AccountApi.md#get_usage) | **GET** /v1/usage | API usage and quota
*ArbitrageApi* | [**get_cross_exchange_arbitrage**](docs/ArbitrageApi.md#get_cross_exchange_arbitrage) | **GET** /v1/arbitrage/cross-exchange | Cross-exchange arbitrage
*ArbitrageApi* | [**get_spot_perp_arbitrage**](docs/ArbitrageApi.md#get_spot_perp_arbitrage) | **GET** /v1/arbitrage/spot-perp | Spot-perp arbitrage
*CategoriesApi* | [**get_ecosystems_data**](docs/CategoriesApi.md#get_ecosystems_data) | **GET** /v1/ecosystems/data | Ecosystems data
*CategoriesApi* | [**get_memecoins_data**](docs/CategoriesApi.md#get_memecoins_data) | **GET** /v1/memecoins/data | Memecoins data
*CategoriesApi* | [**get_narratives_data**](docs/CategoriesApi.md#get_narratives_data) | **GET** /v1/narratives/data | Narratives data
*DerivativesApi* | [**get_funding_rates**](docs/DerivativesApi.md#get_funding_rates) | **GET** /v1/funding/rates | Funding rates
*DerivativesApi* | [**get_futures_coins**](docs/DerivativesApi.md#get_futures_coins) | **GET** /v1/futures/coins | Available futures coins
*DerivativesApi* | [**get_futures_data**](docs/DerivativesApi.md#get_futures_data) | **GET** /v1/futures/data | Futures chart data
*DerivativesApi* | [**get_options_data**](docs/DerivativesApi.md#get_options_data) | **GET** /v1/options/data | Options chart data
*ExchangeListingsApi* | [**get_listings_data**](docs/ExchangeListingsApi.md#get_listings_data) | **GET** /v1/listings/data | Exchange listings hub data
*ExchangeListingsApi* | [**get_listings_recent**](docs/ExchangeListingsApi.md#get_listings_recent) | **GET** /v1/listings/recent | Recent exchange listings
*MarketDataApi* | [**get_correlation_matrix**](docs/MarketDataApi.md#get_correlation_matrix) | **GET** /v1/correlation/matrix | Correlation matrix
*MarketDataApi* | [**get_derivatives_overview**](docs/MarketDataApi.md#get_derivatives_overview) | **GET** /v1/market/derivatives-overview | Market-wide derivatives overview
*MarketDataApi* | [**get_gem_finder_data**](docs/MarketDataApi.md#get_gem_finder_data) | **GET** /v1/gem-finder/data | Gem finder
*MarketDataApi* | [**get_heatmap_data**](docs/MarketDataApi.md#get_heatmap_data) | **GET** /v1/heatmap/data | Market heatmap
*MarketDataApi* | [**get_market_overview**](docs/MarketDataApi.md#get_market_overview) | **GET** /v1/tracker/market-overview | Market overview
*MarketDataApi* | [**get_news_feed**](docs/MarketDataApi.md#get_news_feed) | **GET** /v1/news/feed | News feed
*MarketDataApi* | [**get_price_prediction_data**](docs/MarketDataApi.md#get_price_prediction_data) | **GET** /v1/price-prediction/data | Price prediction
*MarketDataApi* | [**search_market_cap**](docs/MarketDataApi.md#search_market_cap) | **GET** /v1/market-cap/search | Market cap search
*SystemApi* | [**get_coverage**](docs/SystemApi.md#get_coverage) | **GET** /v1/meta/coverage | API data coverage
*SystemApi* | [**get_health**](docs/SystemApi.md#get_health) | **GET** /v1/health | Health check


## Documentation For Models

 - [ApiMeta](docs/ApiMeta.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [FuturesCoin](docs/FuturesCoin.md)
 - [GetFundingRates200Response](docs/GetFundingRates200Response.md)
 - [GetFuturesCoins200Response](docs/GetFuturesCoins200Response.md)
 - [GetFuturesCoins200ResponseAllOfData](docs/GetFuturesCoins200ResponseAllOfData.md)
 - [GetUsage200Response](docs/GetUsage200Response.md)
 - [HealthResponse](docs/HealthResponse.md)
 - [HealthResponseChecks](docs/HealthResponseChecks.md)
 - [PaginatedEnvelope](docs/PaginatedEnvelope.md)
 - [PaginationInfo](docs/PaginationInfo.md)
 - [SuccessEnvelope](docs/SuccessEnvelope.md)
 - [UsageData](docs/UsageData.md)
 - [UsageDataLast24h](docs/UsageDataLast24h.md)
 - [UsageDataLast24hByEndpointValue](docs/UsageDataLast24hByEndpointValue.md)
 - [UsageDataPlan](docs/UsageDataPlan.md)
 - [UsageDataQuota](docs/UsageDataQuota.md)
 - [UsageDataRateLimit](docs/UsageDataRateLimit.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication

<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header


## Author

support@sharpe.ai


