Docs
Flowseeker/API Reference/Underlying

Flux Field level and bands for a ticker

GEThttps://api.skylit.ai/v1/underlying/{ticker}/flux-field

Skylit's proprietary Flux Field for the underlying: a level with an inner, an outer and an extreme band around it, the same series the Flux Field indicator draws on Skylit charts. Price above the level means aggressive buyers are in control; a tag of the outer band is stretched, and the extreme band is reached only on outsized moves. Reclaiming or losing the level or the inner band frames trend entries and exits.

One point per regular-hours minute (resolution=1min) or per trading day (resolution=1d, the session's last value). Minutes without qualifying options activity carry no point. Off-hours and on a holiday the latest session is returned.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Path parameters

  • tickerstringrequired

    Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

  • intervalstringdefault 1D

    Trading days covered, ending with date: 1D to 30D at resolution=1min, 1D to 252D (one year) at resolution=1d. Data covers the last 365 calendar days, so a window reaching further back (an older date) returns only the days inside it.

  • resolutionstringdefault 1min

    One point per minute (1min) or per trading day (1d).

    1min1d
  • anchorstring

    Where the level restarts: every session, or the start of each week, month, quarter or year (carried across sessions). Defaults to session at resolution=1min and month at resolution=1d.

    sessionweekmonthquarteryear
  • datestringdate

    Last trading day covered. Defaults to the current or latest session.

  • limitintegermin 1

    Return only the most recent N points of the window (default: all). The bands are computed over the whole window either way.

Responses

  • 200

    Flux Field points, oldest first.

  • 400

    Request validation failed.

  • 401

    Missing or invalid API key.

  • 402

    The account's shared Skylit credit balance is lower than this route's cost. Top up to continue. Carries X-Credits-Remaining: 0.

  • 403

    Unknown, revoked or expired API key (the gateway's forbidden), the account's API access is suspended (account_suspended) or blocked (account_blocked). Not retryable.

  • 404

    Unknown ticker or contract (SYMBOL_NOT_FOUND), or no data for the requested window. Not charged.

  • 429

    Either the key exceeded its requests-per-minute limit (X-RateLimit-Limit; no Retry-After, wait until X-RateLimit-Reset), or the account is over one of the API's own limits, such as the query budget (queries running at once, fresh queries per second): TOO_MANY_CONCURRENT_QUERIES or RATE_LIMITED with Retry-After. Not charged; retry after the wait.

  • 500

    Unexpected server error (INTERNAL_ERROR, DATABASE_ERROR). Not charged; safe to retry with exponential backoff.

  • 503

    Underlying data source temporarily unavailable, the credit balance could not be verified (credit_check_failed), or the API is paused for maintenance (api_paused, with a Retry-After header and a retry_after field in seconds). Not charged; safe to retry.

  • 504

    The request did not complete within 25 seconds. Not charged; narrow the window or retry.

Response fields

  • dataobjectrequired
    • tickerstringrequired
    • intervalstringrequired
    • resolutionstringrequired
      1min1d
    • anchorstringrequired
      sessionweekmonthquarteryear
    • pointsobject[]required
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

    • nextCursorstring

      Trade feeds (/v1/flow/{ticker}, /v1/contract/{symbol}/trades): pass back as cursor with the same filters for the next page. Present only when more rows may follow.

    • nextEndTimestringdate-time

      /v1/flow/{ticker} only: the last row's exact time (RFC 3339 with nanoseconds), for end_time paging. Inclusive, so rows at that instant can repeat; nextCursor never repeats or skips.

    • warningsobject[]

      Present only when the answer was adjusted or is incomplete.

Last updated

Was this page helpful?