CCXT.Credentials (ccxt_client v0.6.1)

API credentials for exchange authentication.

Requires api_key and secret at minimum. Some exchanges also need password (OKX, KuCoin) or uid.

Credentials are always passed explicitly — this module never reads from environment variables or application config.

Examples

{:ok, creds} = CCXT.Credentials.new(api_key: "abc", secret: "xyz")

creds = CCXT.Credentials.new!(api_key: "abc", secret: "xyz", sandbox: true)

Summary

Types

t()

Functions

new(opts)

Creates credentials from a keyword list.

new!(opts)

Creates credentials from a keyword list, raising on invalid input.

Types

t()

@type t() :: %CCXT.Credentials{
  api_key: String.t(),
  password: String.t() | nil,
  sandbox: boolean(),
  secret: String.t(),
  uid: String.t() | nil
}

Functions

new(opts)

@spec new(keyword()) ::
  {:ok, t()}
  | {:error,
     :missing_api_key
     | :missing_secret
     | {:invalid_type, atom()}
     | {:unknown_key, atom()}}

Creates credentials from a keyword list.

Returns {:ok, credentials} or {:error, reason}.

Examples

{:ok, creds} = CCXT.Credentials.new(api_key: "abc", secret: "xyz")
{:error, :missing_api_key} = CCXT.Credentials.new(secret: "xyz")

new!(opts)

@spec new!(keyword()) :: t()

Creates credentials from a keyword list, raising on invalid input.

Examples

creds = CCXT.Credentials.new!(api_key: "abc", secret: "xyz")