> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sharpe.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check

> Returns database reachability and News article freshness. The service is degraded when the database is unavailable or the newest News article is stale or has unknown freshness. It also lists per-dataset freshness (`datasets`) read from the snapshot index and the cache rows; a stale dataset does not make the service degraded. No authentication required.



## OpenAPI

````yaml /openapi.json get /v1/health
openapi: 3.0.0
info:
  title: Sharpe API
  version: 1.0.0
  description: >-
    Institutional-grade crypto market data API. Access funding rates, futures,
    arbitrage opportunities, narratives, ecosystems, and more.


    Authentication is supported via two production-safe methods:

    1. **Bearer token** in the Authorization header: `Authorization: Bearer
    sk_live_...`

    2. **X-API-Key header**: `X-API-Key: sk_live_...`


    API keys in query parameters are rejected by default because URLs are
    commonly stored in logs, browser history, analytics tools, and referrer
    headers.


    These `/v1` endpoints send no CORS headers and must be called from a server:
    calling them from a browser would expose your API key in page JavaScript.


    Every endpoint needs an API key, except `/v1/health` and
    `/v1/meta/coverage`. A key works on a paid plan
    (https://www.sharpe.ai/pricing) or during its account's one-time trial of 7
    days and 250 requests; otherwise it answers 401 `expired_api_key`. There is
    no free API tier and no keyless API.
  contact:
    name: Sharpe API Support
    url: https://sharpe.ai
    email: team@sharpe.ai
servers:
  - url: https://www.sharpe.ai/api
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health checks and service status
  - name: Account
    description: API key usage and quota information
  - name: Derivatives
    description: Funding rates and futures data
  - name: Market Data
    description: >-
      Heatmaps, correlations, tracker, price predictions, news, gem finder, and
      market cap search
  - name: Arbitrage
    description: >-
      Spot-perp, cross-exchange, dated futures basis, calendar spread,
      perp-dated carry, and transfer arbitrage scanners
  - name: Categories
    description: Narratives, ecosystems, and memecoins data
  - name: New Listings
    description: >-
      Spot listings, Perp listings, delistings, suspensions, scheduled trading
      starts, exchange pages, and narrative flow across CEXs and Perp DEXs.
  - name: Screener
    description: Rug Check security, holders, resolve and trending endpoints.
  - name: Signals
    description: >-
      Composite signal scores derived from cross-exchange derivatives data:
      insider selling pressure and pump-and-dump detection.
  - name: Reports
    description: >-
      Markdown reports rendered on the server from the endpoints above: the
      market briefing, one coin's analysis, and the funding-arbitrage
      opportunities.
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Health check
      description: >-
        Returns database reachability and News article freshness. The service is
        degraded when the database is unavailable or the newest News article is
        stale or has unknown freshness. It also lists per-dataset freshness
        (`datasets`) read from the snapshot index and the cache rows; a stale
        dataset does not make the service degraded. No authentication required.
      operationId: getHealth
      responses:
        '200':
          description: Service is healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '503':
          description: Service is degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
        version:
          type: string
          example: v1
        checks:
          type: object
          properties:
            database:
              type: boolean
            news:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - fresh
                    - stale
                    - unknown
                latest_published_at:
                  nullable: true
                  type: string
                  format: date-time
                age_seconds:
                  nullable: true
                  type: integer
                  minimum: 0
                freshness_sla_seconds:
                  type: integer
                  example: 21600
                future_tolerance_seconds:
                  type: integer
                  example: 300
                unknown_reason:
                  nullable: true
                  type: string
                  enum:
                    - missing
                    - invalid
                    - future
                    - query_error
                    - database_unavailable
              required:
                - status
                - latest_published_at
                - age_seconds
                - freshness_sla_seconds
                - future_tolerance_seconds
                - unknown_reason
          required:
            - database
            - news
        datasets:
          nullable: true
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                properties:
                  dataset_id:
                    type: string
                    enum:
                      - funding_rates_current
                      - funding_rates_history
                      - funding_accumulated
                      - funding_fee_settlement
                      - global_overview_snapshot
                      - futures_open_interest
                      - futures_basis
                      - futures_term_structure
                      - futures_liquidations
                      - futures_long_short_ratio
                      - futures_ohlcv
                      - futures_coins
                      - rwa_perp_rates_current
                      - arbitrage_tickers
                      - arbitrage_boards
                      - arbitrage_dated_quotes
                      - narratives
                      - ecosystems
                      - memecoins
                      - mindshare
                      - sectors
                      - chains
                      - sector_coins
                      - chain_coins
                      - gem_finder
                      - web_traffic
                      - heatmap_cache
                      - stablecoins
                      - news
                      - listings
                      - memecoin_launches
                      - rug_check_inputs
                      - rug_check_trending
                      - pump_dump
                      - insider_pressure
                      - price_prediction_inputs
                      - correlation_prices
                      - market_cap_search
                      - coingecko_coin_list
                      - boros_markets
                      - margin_borrow_rates
                  store:
                    type: string
                    enum:
                      - serve_snapshot
                      - tracker_cache
                      - heatmap_cache
                      - global_overview_snapshot
                  scope:
                    type: string
                    description: >-
                      The serve_snapshot scope, the cache row key, or the
                      /global tab.
                  as_of:
                    nullable: true
                    type: string
                    format: date-time
                  stale_after:
                    nullable: true
                    type: string
                    format: date-time
                  freshness_sla_seconds:
                    type: integer
                  freshness_status:
                    type: string
                    enum:
                      - fresh
                      - stale
                      - unknown
                  unknown_reason:
                    nullable: true
                    type: string
                    enum:
                      - missing
                      - undated
                      - query_error
                required:
                  - dataset_id
                  - store
                  - scope
                  - as_of
                  - stale_after
                  - freshness_sla_seconds
                  - freshness_status
                  - unknown_reason
            warnings:
              type: array
              items:
                type: string
          required:
            - items
            - warnings
          description: >-
            Per-dataset freshness; null when the database was unreachable
            (nothing was checked). A stale dataset does not make the service
            degraded.
        request_id:
          type: string
        timestamp:
          type: string
          format: date-time
      required:
        - status
        - version
        - checks
        - request_id
        - timestamp
  headers:
    X-Request-Id:
      schema:
        type: string
      description: Unique request identifier. Include this value when contacting support.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a Bearer token in the Authorization header:
        `Authorization: Bearer sk_live_...`
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternatively, pass your API key via the X-API-Key header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.