https://github.com/crunchysoul/spacex_ex

An Elixir wrapper for r-spacex/SpaceX-API
https://github.com/crunchysoul/spacex_ex

api-wrapper elixir spacex-api

Last synced: about 1 month ago
JSON representation

An Elixir wrapper for r-spacex/SpaceX-API

• Host: GitHub
• URL: https://github.com/crunchysoul/spacex_ex
• Owner: crunchysoul
• Created: 2018-08-16T11:39:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-29T05:06:54.000Z (over 6 years ago)
• Last Synced: 2024-09-22T01:47:55.953Z (4 months ago)
• Topics: api-wrapper, elixir, spacex-api
• Language: Elixir
• Size: 32.2 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




# 🚀 Elixir SpaceX API Wrapper 

[![GitHub release](https://img.shields.io/github/release/crunchysoul/spacex_ex.svg)](https://github.com/crunchysoul/spacex_ex/releases)

[![GitHub issues](https://img.shields.io/github/issues/crunchysoul/spacex_ex.svg)](https://github.com/crunchysoul/spacex_ex/issues)

[![GitHub stars](https://img.shields.io/github/stars/crunchysoul/spacex_ex.svg)](https://github.com/crunchysoul/spacex_ex/stargazers)

[![GitHub license](https://img.shields.io/github/license/crunchysoul/spacex_ex.svg)](https://github.com/crunchysoul/spacex_ex)

### A simple API wrapper for [r-spacex/SpaceX-API](https://github.com/r-spacex/SpaceX-API) in Elixir!







## Table of Contents

- [Documentation](#documentation)

- [Installation](#installation)

- [Usage](#basic-usage)

## Documentation

See the [Wiki](https://github.com/crunchysoul/spacex_ex/wiki) for full wrapper documentation.

## Installation

[available in Hex](https://hex.pm/packages/spacex_ex/1.0.0), the package can be installed

by adding `spacex_ex` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:spacex_ex, "~> 1.0.0"}

  ]

end

```

## Basic Usage

```elixir

# List of all SpaceX capsule information

{200, capsules} = SpacexEx.capsules

# List of past SpacexEx.launch information

{200, past_launches} = SpacexEx.launches

# List of all SpaceX launch information

{200, all_launches} = SpacexEx.launches_all

# Next SpaceX launch information

{200, next_launch} = SpacexEx.launches_next

# Latest SpaceX launch information

{200, latest_launch} = SpacexEx.launches_latest

# Upcoming SpaceX launch information

{200, upcoming_launch} = SpacexEx.launches_upcoming

# List of all SpaceX launchpad information

{200, launchpads} = SpacexEx.launchpads

# List of all SpaceX mission information

{200, missions} = SpacexEx.missions

# List of all SpaceX capsule part information

{200, part_capsules} = SpacexEx.part_capsules

# List of all SpaceX core part information

{200, part_cores} = SpacexEx.part_cores

# List of all SpaceX payload information

{200, payloads} = SpacexEx.payloads

# List of all SpaceX rocket information

{200, rockets} = SpacexEx.rockets

# Get SpaceX company information

{200, spacex_info} = SpacexEx.info

# Get the SpaceX Roadster information

{200, spacex_roadster} = SpacexEx.info_roadster

# Get SpaceX history information

{200, spacex_history} = SpacexEx.info_history 

# Get a SpaceX capsule information by id

{200, capsule} = SpacexEx.capsules("dragon1")

# Get a SpaceX launchpad information by id

{200, launchpad} = SpacexEx.launchpads("ksc_lc_39a")

# Get a SpaceX missions information by id

{200, mission} = SpacexEx.missions("6C42550")

# Get a SpaceX capsule part information by id

{200, part_capsule} = SpacexEx.part_capsules("C111")

# Get a SpaceX capsule core information by id

{200, part_core} = SpacexEx.part_cores("B1029")

# Get a SpaceX payloads information by id

{200, payload} = SpacexEx.payloads("SpaceX CRS-11")

# Get a SpaceX rockets information by id

{200, rocket} = SpacexEx.rockets("bfr")

# Get attributes of a capsule

capsule.name

>>> "Dragon 1"

capsules.crew_capacity

>>> 0

capsules.description

>>> "Dragon is a reusable spacecraft developed by SpaceX. ..."

```