Bourse.OptionReadiness.Credentials (bourse v0.1.0)

Copy Markdown View Source

Credential and environment resolution for the four option readiness venues.

Missing credentials fail loudly with exact setup instructions. Bybit uses demo-trading keys (not the read-only testnet key); OKX uses international demo credentials against www.okx.com.

Summary

Types

resolved()

Functions

build_exchange(venue)

Builds a sandbox/demo exchange or returns a loud missing-credentials error.

default_environment(other)

Default environment label for a venue.

default_request_opts(arg1)

Default per-call request opts (e.g. Bybit demo base_url).

setup_instructions(venue)

Exact setup instructions for a venue's option readiness credentials.

Types

resolved()

@type resolved() :: {Bourse.Exchange.t(), String.t(), keyword()}

Functions

build_exchange(venue)

@spec build_exchange(String.t()) ::
  {:ok, Bourse.Exchange.t(), String.t(), keyword()} | {:error, Bourse.Error.t()}

Builds a sandbox/demo exchange or returns a loud missing-credentials error.

default_environment(other)

@spec default_environment(String.t()) :: String.t()

Default environment label for a venue.

default_request_opts(arg1)

@spec default_request_opts(String.t()) :: keyword()

Default per-call request opts (e.g. Bybit demo base_url).

setup_instructions(venue)

@spec setup_instructions(String.t()) :: String.t()

Exact setup instructions for a venue's option readiness credentials.