sodonnell/spacetrack

Simple Space-Track.org API Client written in PHP.

Maintainers

Details

github.com/sodonnell/spacetrack

Source

Issues

Installs: 520

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

1.6 2019-05-06 23:48 UTC

Requires

  • php: >=5.0.0

MIT 85fec7f640a896cd48bc37baeacc8fc58355fb94

apiSpaceTrack

This package is auto-updated.

Last update: 2024-04-27 20:04:09 UTC

README

A generic REST/JSON API client for the space-track.org web service, written in PHP.

The design concept for this class is to create a universal (PHP) object specifically to interact with all of the space-track.org API services, with as minimal code as possible.

This class supports the bandwidth-throttling suggested by the API documentation (100k/sec transfers), to minimize service bandwidth spikes.

Ideally, you should be able to create scripts to interact with the space-track.org API endpoint of your preference, via crontab (on a daily/weekly/monthly basis), and store/sync the data locally for post-processing via database or (key/value) datastore. Many of the API requests return very large (static) datasets, which do not change frequently, so local data caching is highly suggested.

This project is considered experimental, and is intended for authorized users of the space-track.org web service (only).

Requirements

  • PHP v5.0 or higher, compiled w/ the CURL extension
  • An authorized user account on space-track.org

Installation

composer require "sodonnell/spacetrack"

Getting started

Usage Example

<?php
require './vendor/autoload.php';

$credentials = [
    'username'=>'???your-username???',
    'password'=>'???your-password???',
];

$cookie = '/tmp/spacetrack.cookie.txt';

use SpaceTrack\SpaceTrack;

SpaceTrack::init($credentials,$cookie);

// optional parameter: decode JSON to PHP Array?
$decode=true;
$response = SpaceTrack::getLaunchSite($decode);

print_r($response);

Available Functions

  • SpaceTrack::init(array $credentials, string $cookie)
  • SpaceTrack::getAnnouncement(bool $decode_json)
  • SpaceTrack::getBoxScore(bool $decode_json)
  • SpaceTrack::getCSM(bool $decode_json)
  • SpaceTrack::getDecay(bool $decode_json)
  • SpaceTrack::getLaunchSite(bool $decode_json)
  • SpaceTrack::getOMM(bool $decode_json)
  • SpaceTrack::getOrganization(bool $decode_json)
  • SpaceTrack::getSatCat(bool $decode_json)
  • SpaceTrack::getSatCatChange(bool $decode_json)
  • SpaceTrack::getSatCatDebut(bool $decode_json)
  • SpaceTrack::getTip(bool $decode_json)
  • SpaceTrack::getTLE(bool $decode_json)
  • SpaceTrack::getTLELatest(bool $decode_json)
  • SpaceTrack::getTLEPublish(bool $decode_json)