ExFPL.Bootstrap (ExFPL v0.1.0)

Copy Markdown View Source

Fetch the global game snapshot from /bootstrap-static/.

The response is large (~1 MB) and changes infrequently within a gameweek. By default it is cached in the application-supervised ExFPL.Cache ETS table for one hour. Pass cache: false to bypass; pass raw: true to receive the original JSON-decoded map instead of an ExFPL.Snapshot struct.

Summary

Types

fetch_opts()

Functions

fetch(opts \\ [])

Fetch the bootstrap snapshot.

Types

fetch_opts()

@type fetch_opts() :: [cache: boolean(), raw: boolean()] | keyword()

Functions

fetch(opts \\ [])

@spec fetch(fetch_opts()) :: {:ok, ExFPL.Snapshot.t() | map()} | {:error, term()}

Fetch the bootstrap snapshot.