ExShla v0.1.1 ExShla View Source

ExShla - The Rick and Morty API Wrapper

Characters

# Single character by ID
iex> ExShla.character(1)

# Multiple characters by name
iex> ExShla.characters(name: "morty")

# Multiple characters by status
iex> ExShla.characters(status: "alive")

# Multiple characters by species
iex> ExShla.characters(species: "human")

# Multiple characters by type
iex> ExShla.characters(type: "cyborg")

# Multiple characters by gender
iex> ExShla.characters(gender: "unknown")

# Combine character filters
iex> ExShla.characters(name: "rick", status: "dead")

Episodes

# Single episode by ID
iex> ExShla.episode(1)

# Multiple episodes by name
iex> ExShla.episodes(name: "morty")

# Multiple episodes by episode code
iex> ExShla.episodes(episode: "s02")

# Combine episode filters
iex> ExShla.episodes(name: "rick", episode: "s01")

Locations

# Single location by ID
iex> ExShla.location(1)

# Multiple locations by name
iex> ExShla.locations(name: "earth")

# Multiple locations by type
iex> ExShla.locations(type: "planet")

# Combine location filters
iex> ExShla.locations(type: "planet", dimension: "c-137")

Link to this section Summary

Functions

Fetches a character by ID

Fetches a list of characters

Fetches an episode by ID

Fetches a list of episodes

Returns information about all available resources

Fetches a location by ID

Fetches a list of locations

Link to this section Functions

Fetches a character by ID.

Link to this function characters(query \\ []) View Source
characters(query :: keyword()) :: ExShla.Resource.Character.result()

Fetches a list of characters.

Optionally filtered by name/status/species/type/gender.

Fetches an episode by ID.

Link to this function episodes(query \\ []) View Source
episodes(query :: keyword()) :: ExShla.Resource.Episode.result()

Fetches a list of episodes.

Optionally filtered by name/episode.

Returns information about all available resources.

Fetches a location by ID.

Link to this function locations(query \\ []) View Source
locations(query :: keyword()) :: ExShla.Resource.Location.result()

Fetches a list of locations.

Optionally filtered by name/type/dimension.