@sharpe-labs/[email protected]

A TypeScript SDK client for the api.sharpe.ai API.

Usage

First, install the SDK from npm.

npm install @sharpe-labs/api --save

Next, try it out.

import {
  Configuration,
  AccountApi,
} from '@sharpe-labs/api';
import type { GetUsageRequest } from '@sharpe-labs/api';

async function example() {
  console.log("🚀 Testing @sharpe-labs/api SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: ApiKeyAuth
    apiKey: "YOUR API KEY",
    // Configure HTTP bearer authorization: BearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AccountApi(config);

  try {
    const data = await api.getUsage();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

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

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AccountApi | getUsage | GET /v1/usage | API usage and quota ArbitrageApi | getCrossExchangeArbitrage | GET /v1/arbitrage/cross-exchange | Cross-exchange arbitrage ArbitrageApi | getSpotPerpArbitrage | GET /v1/arbitrage/spot-perp | Spot-perp arbitrage CategoriesApi | getEcosystemsData | GET /v1/ecosystems/data | Ecosystems data CategoriesApi | getMemecoinsData | GET /v1/memecoins/data | Memecoins data CategoriesApi | getNarrativesData | GET /v1/narratives/data | Narratives data DerivativesApi | getFundingRates | GET /v1/funding/rates | Funding rates DerivativesApi | getFuturesCoins | GET /v1/futures/coins | Available futures coins DerivativesApi | getFuturesData | GET /v1/futures/data | Futures chart data DerivativesApi | getOptionsData | GET /v1/options/data | Options chart data ExchangeListingsApi | getListingsData | GET /v1/listings/data | Exchange listings hub data ExchangeListingsApi | getListingsRecent | GET /v1/listings/recent | Recent exchange listings MarketDataApi | getCorrelationMatrix | GET /v1/correlation/matrix | Correlation matrix MarketDataApi | getDerivativesOverview | GET /v1/market/derivatives-overview | Market-wide derivatives overview MarketDataApi | getGemFinderData | GET /v1/gem-finder/data | Gem finder MarketDataApi | getHeatmapData | GET /v1/heatmap/data | Market heatmap MarketDataApi | getMarketOverview | GET /v1/tracker/market-overview | Market overview MarketDataApi | getNewsFeed | GET /v1/news/feed | News feed MarketDataApi | getPricePredictionData | GET /v1/price-prediction/data | Price prediction MarketDataApi | searchMarketCap | GET /v1/market-cap/search | Market cap search SystemApi | getCoverage | GET /v1/meta/coverage | API data coverage SystemApi | getHealth | GET /v1/health | Health check

Models

• ApiMeta
• ErrorResponse
• FuturesCoin
• GetFundingRates200Response
• GetFuturesCoins200Response
• GetFuturesCoins200ResponseAllOfData
• GetUsage200Response
• HealthResponse
• HealthResponseChecks
• PaginatedEnvelope
• PaginationInfo
• SuccessEnvelope
• UsageData
• UsageDataLast24h
• UsageDataLast24hByEndpointValue
• UsageDataPlan
• UsageDataQuota
• UsageDataRateLimit

Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: HTTP Bearer Token authentication

ApiKeyAuth

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

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

For more information, please visit https://sharpe.ai

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License