ryan-senn / stellar-elm-sdk / Stellar.Endpoints.OrderbookDetails

Orderbook Details Endpoint

Build the Request with required fields

requestBuilder : Stellar.Endpoint.Endpoint -> Stellar.AssetType.AssetType -> Stellar.AssetType.AssetType -> HttpBuilder.RequestBuilder Response

Request Builder. Takes the mandatory fields as arguments, the optional fields can be piped using setters.

Configure optional fields

setSellingAssetCode : String -> HttpBuilder.RequestBuilder Response -> HttpBuilder.RequestBuilder Response

Set the selling Asset Code.

setSellingAssetIssuer : Stellar.PublicKey.PublicKey -> HttpBuilder.RequestBuilder Response -> HttpBuilder.RequestBuilder Response

Set the selling Asset Issuer.

setBuyingAssetCode : String -> HttpBuilder.RequestBuilder Response -> HttpBuilder.RequestBuilder Response

Set the buying Asset Code.

setBuyingAssetIssuer : Stellar.PublicKey.PublicKey -> HttpBuilder.RequestBuilder Response -> HttpBuilder.RequestBuilder Response

Set the buying Asset Issuer.

Configure pagination

setLimit : Basics.Int -> HttpBuilder.RequestBuilder Response -> HttpBuilder.RequestBuilder Response

Set the pagination limit for the Request.

Send the Request & catch Response

send : (Result Http.Error Response -> msg) -> HttpBuilder.RequestBuilder Response -> Platform.Cmd.Cmd msg

Send the request once configured.


type Response
    = Error Stellar.Error.Error
    | Success Stellar.Resources.Orderbook.Orderbook

The Response coming back from the server.