lovebug356 / elm-crypto-com-exchange / CryptoComExchange.Configuration

This module allows to define your custom configuration on how to use the API.

Definition


type Configuration

A configuration that can be used for all public APis.


type alias PrivateConfiguration =
{ endpoint : String
, apiKey : ApiKey
, secretKey : SecretKey
, timestamp : Time.Posix 
}

A configuration with authentication information.


type alias PublicConfiguration =
{ endpoint : String }

A configuration without authentication information.


type ApiKey
    = ApiKey String

Randomly generated API key.


type SecretKey
    = SecretKey String

Randomly generated secret key.

Helpers

createSandbox : Configuration

Create a configuration for the sandbox environment.

createProduction : Configuration

Create a configuration for the production environment.

createPrivateConfiguration : PrivateConfiguration -> Configuration

Create a Configuration from a PrivateConfiguration

withTimestamp : Time.Posix -> PrivateConfiguration -> PrivateConfiguration

Add a new timestamp to the PrivateConfiguration.

withApiKey : ApiKey -> SecretKey -> Configuration -> PrivateConfiguration

Add ApiKey and SecretKey to a configuration.

More information about generating an API key can be found here. https://exchange-docs.crypto.com/spot/index.html#generating-the-api-key

endpoint : Configuration -> String

Get the endpoint of a configuration.