Skip to content

Commit

Permalink
add docs folder
Browse files Browse the repository at this point in the history
  • Loading branch information
jakewmeyer committed Jul 15, 2018
1 parent 1bfd558 commit 6b09770
Show file tree
Hide file tree
Showing 10 changed files with 574 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api_clients.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Community made API Clients / Wrappers

**.NET**
* [Tearth/Oddity](https://github.com/Tearth/Oddity)

**Node.js**
* [Thomas-Smyth/SpaceX-API-Wrapper](https://github.com/Thomas-Smyth/SpaceX-API-Wrapper)

**PowerShell**
* [lazywinadmin/SpaceX](https://github.com/lazywinadmin/SpaceX)
83 changes: 83 additions & 0 deletions docs/capsule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
Get all capsule information
```http
GET https://api.spacexdata.com/v2/capsules
```

Get specific capsule information
```http
GET https://api.spacexdata.com/v2/capsules/dragon1
GET https://api.spacexdata.com/v2/capsules/dragon2
GET https://api.spacexdata.com/v2/capsules/crewdragon
```

Sample Response
```json
{
"id": "dragon2",
"name": "Dragon 2",
"type": "capsule",
"active": false,
"crew_capacity": 0,
"sidewall_angle_deg": 15,
"orbit_duration_yr": 2,
"heat_shield": {
"material": "PICA-X",
"size_meters": 3.6,
"temp_degrees": 3000,
"dev_partner": "NASA"
},
"thrusters": [
{
"type": "Draco",
"amount": 18,
"pods": 4,
"fuel_1": "nitrogen tetroxide",
"fuel_2": "monomethylhydrazine",
"thrust": {
"kN": 0.4,
"lbf": 90
}
}
],
"launch_payload_mass": {
"kg": 6000,
"lb": 13228
},
"launch_payload_vol": {
"cubic_meters": 25,
"cubic_feet": 883
},
"return_payload_mass": {
"kg": 3000,
"lb": 6614
},
"return_payload_vol": {
"cubic_meters": 11,
"cubic_feet": 388
},
"pressurized_capsule": {
"payload_volume": {
"cubic_meters": 11,
"cubic_feet": 388
}
},
"trunk": {
"trunk_volume": {
"cubic_meters": 14,
"cubic_feet": 494
},
"cargo": {
"solar_array": 2,
"unpressurized_cargo": true
}
},
"height_w_trunk": {
"meters": 7.2,
"feet": 23.6
},
"diameter": {
"meters": 3.7,
"feet": 12
}
}
```
39 changes: 39 additions & 0 deletions docs/capsule_detail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Get detailed info on all capsules
```http
GET https://api.spacexdata.com/v2/parts/caps
```
Get specific capsule data
```http
GET https://api.spacexdata.com/v2/parts/caps/C113
```
Sample Response
```json
{
"capsule_serial": "C113",
"capsule_id": "dragon1",
"status": "active",
"original_launch": "2017-08-14T16:31:00.000Z",
"original_launch_unix": 1502728260,
"missions": [
"SpaceX CRS-12"
],
"landings": 1,
"type": "Dragon 1.1",
"details": "The last newly manufactured Dragon 1"
}

```
Filter all capsules by using any combination of these querystrings
```http
GET https://api.spacexdata.com/v2/parts/caps?status=active
```

| Query Stings | Description |
| ------------- | ------------- |
| capsule_serial | Filter by capsule serial # |
| capsule_id | Filter by capsule id |
| status | Filter by capsule status |
| original_launch | Filter by original launch date |
| missions | Filter by flight missions |
| landings | Filter by # of landings |
| type | Filter by type of dragon capusle |
22 changes: 22 additions & 0 deletions docs/company_info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Info
Get company info
```http
GET https://api.spacexdata.com/v2/info
```

# History
Get company history / milestones
```http
GET https://api.spacexdata.com/v2/info/history
```

## Querystring Response Notes
* By default, this endpoint returns an array of JSON objects when queried
* If no match is found when using querystring filtering, an empty array is returned `[]` with a 200 response code

## Query String Options
| Query Strings | Description |
| ------------- | ------------- |
| start & end | Filter by a date range |
| flight\_number | Filter history events by flight number |
| order | Change result ordering by `asc` or `desc` |
48 changes: 48 additions & 0 deletions docs/core_detail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Get detailed info on all cores
```http
GET https://api.spacexdata.com/v2/parts/cores
```

Get specific core data
```http
GET https://api.spacexdata.com/v2/parts/cores/B1041
```

Sample Response
```json
{
"core_serial": "B1041",
"block": 4,
"status": "expended",
"original_launch": "2017-10-09T12:37:00.000Z",
"original_launch_unix": 1507552620,
"missions": [
"Iridium NEXT 21-30",
"Iridium NEXT 41-50"
],
"rtls_attempt": false,
"rtls_landings": 0,
"asds_attempt": true,
"asds_landings": 1,
"water_landing": false,
"details": "Will fly expendable on Iridium NEXT 41-50"
}
```

Filter cores by using any combination of these querystrings
```http
GET https://api.spacexdata.com/v2/parts/cores?status=active
```

| Query Stings | Description |
| ------------- | ------------- |
| core_serial | Filter by core serial # |
| block | Filter by core block number |
| status | Filter by flight status |
| original_launch | Filter by original launch date |
| missions | Filter by flight missions |
| rtls_attempt | Filter by at least 1 rtls attempt |
| rtls_landings | Filter by total number of landings |
| asds_attempt | Filter by at least 1 asds attempt |
| asds_landings | Filter by total number of landings |
| water_landing | Filter by at least 1 water landing |
34 changes: 34 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
### Without Docker

1. Clone the repo
```bash
git clone https://github.com/r-spacex/SpaceX-API.git && cd SpaceX-API
```

2. Install dependencies
```bash
yarn install
```

3. Run ESlint and all tests
```bash
yarn test
```

4. Start the app
```bash
yarn start
```

### With Docker

* Make sure Docker is installed & running
```bash
git clone https://github.com/r-spacex/SpaceX-API.git && cd SpaceX-API
```
```docker
docker-compose build
```
```docker
docker-compose up
```
24 changes: 24 additions & 0 deletions docs/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Introduction
This collection of documents describes the resources and functions that make up the r/SpaceX API.

## Authentication
No authentication is required to use this public API

## Rate Limiting
No rate limiting is implemented at this time, but please be respectful with your usage

## Endpoints

[Company Data](https://github.com/r-spacex/SpaceX-API/wiki/Company-Info)

[Rocket Data](https://github.com/r-spacex/SpaceX-API/wiki/Rocket-Info)

[Capsule Data](https://github.com/r-spacex/SpaceX-API/wiki/Capsule-Info)

[Launchpad Data](https://github.com/r-spacex/SpaceX-API/wiki/Launchpad-Info)

[Launches](https://github.com/r-spacex/SpaceX-API/wiki/Launches)

[Detailed Capsule Data](https://github.com/r-spacex/SpaceX-API/wiki/Capsule-Detail)

[Detailed Core Data](https://github.com/r-spacex/SpaceX-API/wiki/Core-Details)
Loading

0 comments on commit 6b09770

Please sign in to comment.