Skip to content

Response Types

For GPRecord (shared with CelesTrak), see Shared Types.

SATCATRecord

SATCATRecord 

SATCATRecord()

Satellite Catalog (SATCAT) record.

Contains metadata about a cataloged space object. All fields are optional strings since Space-Track may omit fields.

Attributes:

Name Type Description
intldes str | None

International designator
norad_cat_id int | None

NORAD catalog ID
object_type str | None

Object type code
satname str | None

Satellite name
country str | None

Country/organization code
launch str | None

Launch date
site str | None

Launch site
decay str | None

Decay date
period str | None

Orbital period (minutes)
inclination str | None

Inclination (degrees)
apogee str | None

Apogee altitude (km)
perigee str | None

Perigee altitude (km)
comment str | None

Comment
commentcode str | None

Comment code
rcsvalue str | None

RCS value
rcs_size str | None

RCS size category
file str | None

File number
launch_year str | None

Launch year
launch_num str | None

Launch number
launch_piece str | None

Launch piece
current str | None

Current status
object_name str | None

Object name
object_id str | None

Object ID
object_number str | None

Object number
Example 
1
2
3
4
5
6
import brahe as bh

client = bh.SpaceTrackClient("user@example.com", "password")
query = bh.SpaceTrackQuery(bh.RequestClass.SATCAT).filter("NORAD_CAT_ID", "25544").limit(1)
records = client.query_satcat(query)
print(records[0].satname)  # "ISS (ZARYA)"

Initialize instance.

apogee property 

apogee: Any

TODO: Add docstring

comment property 

comment: Any

TODO: Add docstring

commentcode property 

commentcode: Any

TODO: Add docstring

country property 

country: Any

TODO: Add docstring

current property 

current: Any

TODO: Add docstring

decay property 

decay: Any

TODO: Add docstring

file property 

file: Any

TODO: Add docstring

inclination property 

inclination: Any

TODO: Add docstring

intldes property 

intldes: Any

TODO: Add docstring

launch property 

launch: Any

TODO: Add docstring

launch_num property 

launch_num: Any

TODO: Add docstring

launch_piece property 

launch_piece: Any

TODO: Add docstring

launch_year property 

launch_year: int

TODO: Add docstring

norad_cat_id property 

norad_cat_id: Any

TODO: Add docstring

object_id property 

object_id: Any

TODO: Add docstring

object_name property 

object_name: Any

TODO: Add docstring

object_number property 

object_number: Any

TODO: Add docstring

object_type property 

object_type: Any

TODO: Add docstring

perigee property 

perigee: Any

TODO: Add docstring

period property 

period: Any

TODO: Add docstring

rcs_size property 

rcs_size: Any

TODO: Add docstring

rcsvalue property 

rcsvalue: Any

TODO: Add docstring

satname property 

satname: Any

TODO: Add docstring

site property 

site: Any

TODO: Add docstring

FileShareFileRecord

FileShareFileRecord 

FileShareFileRecord()

FileShare file record from the fileshare/file request class.

Contains metadata about a file in a user's Space-Track file share. All fields are optional strings since Space-Track may omit fields.

Attributes:

Name Type Description
file_id str | None

File identifier
file_name str | None

File name
file_link str | None

File download link
file_size str | None

File size in bytes
file_conttype str | None

File content type
folder_id str | None

Folder identifier
created str | None

Creation date
Example 
1
2
3
4
5
6
import brahe as bh

client = bh.SpaceTrackClient("user@example.com", "password")
files = client.fileshare_list_files()
for f in files:
    print(f.file_name, f.file_size)

Initialize instance.

created property 

created: Any

TODO: Add docstring

file_conttype property 

file_conttype: Any

TODO: Add docstring

file_id property 

file_id: Any

TODO: Add docstring

file_link: Any

TODO: Add docstring

file_name property 

file_name: Any

TODO: Add docstring

file_size property 

file_size: Any

TODO: Add docstring

folder_id property 

folder_id: Any

TODO: Add docstring

FolderRecord

FolderRecord 

FolderRecord()

FileShare folder record from the fileshare/folder request class.

Contains metadata about a folder in a user's Space-Track file share. All fields are optional strings since Space-Track may omit fields.

Attributes:

Name Type Description
folder_id str | None

Folder identifier
folder_name str | None

Folder name
parent_folder_id str | None

Parent folder identifier
created str | None

Creation date
Example 
1
2
3
4
5
6
import brahe as bh

client = bh.SpaceTrackClient("user@example.com", "password")
folders = client.fileshare_list_folders()
for f in folders:
    print(f.folder_name, f.folder_id)

Initialize instance.

created property 

created: Any

TODO: Add docstring

folder_id property 

folder_id: Any

TODO: Add docstring

folder_name property 

folder_name: Any

TODO: Add docstring

parent_folder_id property 

parent_folder_id: Any

TODO: Add docstring

SPEphemerisFileRecord

SPEphemerisFileRecord 

SPEphemerisFileRecord()

SP Ephemeris file record from the spephemeris/file request class.

Contains metadata about an SP ephemeris file on Space-Track. All fields are optional strings since Space-Track may omit fields.

Attributes:

Name Type Description
file_id str | None

File identifier
norad_cat_id int | None

NORAD catalog ID
file_name str | None

File name
file_link str | None

File download link
file_size str | None

File size in bytes
created str | None

Creation date
epoch_start str | None

Epoch start
epoch_stop str | None

Epoch stop
Example 
1
2
3
4
5
6
import brahe as bh

client = bh.SpaceTrackClient("user@example.com", "password")
files = client.spephemeris_list_files()
for f in files:
    print(f.file_name, f.norad_cat_id)

Initialize instance.

created property 

created: Any

TODO: Add docstring

epoch_start property 

epoch_start: Any

TODO: Add docstring

epoch_stop property 

epoch_stop: Any

TODO: Add docstring

file_id property 

file_id: Any

TODO: Add docstring

file_link: Any

TODO: Add docstring

file_name property 

file_name: Any

TODO: Add docstring

file_size property 

file_size: Any

TODO: Add docstring

norad_cat_id property 

norad_cat_id: Any

TODO: Add docstring

SpaceTrackEphemerisFileName

SpaceTrackEphemerisFileName 

SpaceTrackEphemerisFileName(norad_cat_id: Any, object_name: Any, start_epoch: Any, category: Any, metadata: Any)

A Space-Track ephemeris file name, field by field.

Space-Track requires submissions to be named <DataType>_<Catalog#>_<CommonName>_<DayTimeGroup>_<Operational/Special>_<MetaData>_<Classification>.<Extension>. str(name) renders the compliant name; the catalog number is zero-padded to five digits.

Example 
1
2
3
4
5
6
7
8
import brahe as bh

start = bh.Epoch(2026, 9, 11, 1, 42, 42.0, 0.0, time_system=bh.TimeSystem.UTC)
name = bh.SpaceTrackEphemerisFileName(100001, "STARLINK-38128", start, bh.SpaceTrackEphemerisFileCategory.OPERATIONAL, "")
assert str(name) == "MEME_100001_STARLINK-38128_2540142_Operational__UNCLASSIFIED.txt"

parsed = bh.SpaceTrackEphemerisFileName.parse("MEME_25544_ISS_1651200_oper__unclassified.txt")
assert parsed.norad_cat_id == 25544

Initialize instance.

category property 

category: SpaceTrackEphemerisFileCategory

Operational or Special.

Returns:

Name Type Description
SpaceTrackEphemerisFileCategory SpaceTrackEphemerisFileCategory

The category.

classification property 

classification: str

Classification field as written.

Returns:

Name Type Description
str str

Classification.

data_type property 

data_type: str

Data type field.

Returns:

Name Type Description
str str

Data type token, normally MEME.

day_of_year property 

day_of_year: int

Day of year of the ephemeris start, UTC.

Returns:

Name Type Description
int int

Day of year, 1 to 366.

extension property 

extension: str

File extension without the dot.

Returns:

Name Type Description
str str

Extension.

hour property 

hour: int

Hour of the ephemeris start, UTC.

Returns:

Name Type Description
int int

Hour, 0 to 23.

metadata property 

metadata: str

Operator-defined metadata.

Returns:

Name Type Description
str str

Metadata field, possibly empty.

minute property 

minute: int

Minute of the ephemeris start, UTC.

Returns:

Name Type Description
int int

Minute, 0 to 59.

norad_cat_id property 

norad_cat_id: int

NORAD catalog number or analyst number.

Returns:

Name Type Description
int int

Catalog number.

object_name property 

object_name: str

Common name of the object.

Returns:

Name Type Description
str str

Object name.

parse staticmethod 

parse(name: str) -> SpaceTrackEphemerisFileName

Parse a file name in the Space-Track convention.

Parameters:

Name Type Description Default
name str

File name with extension, without directory components.

 required

Returns:

Name Type Description
SpaceTrackEphemerisFileName SpaceTrackEphemerisFileName

The parsed fields.

Raises:

Type Description
BraheError

If the name does not follow the convention or a field names a path.

with_classification method descriptor 

with_classification(classification: str) -> SpaceTrackEphemerisFileName

Return a copy with the classification replaced.

Parameters:

Name Type Description Default
classification str

Classification token.

 required

Returns:

Name Type Description
SpaceTrackEphemerisFileName SpaceTrackEphemerisFileName

The updated name.

Raises:

Type Description
BraheError

If classification is empty, contains _, /, a backslash or NUL, or is . or ...

with_data_type method descriptor 

with_data_type(data_type: str) -> SpaceTrackEphemerisFileName

Return a copy with the data type replaced.

Parameters:

Name Type Description Default
data_type str

Data type token, for example MEME or TEME.

 required

Returns:

Name Type Description
SpaceTrackEphemerisFileName SpaceTrackEphemerisFileName

The updated name.

Raises:

Type Description
BraheError

If data_type is empty, contains _, /, a backslash or NUL, or is . or ...

with_extension method descriptor 

with_extension(extension: str) -> SpaceTrackEphemerisFileName

Return a copy with the extension replaced.

Parameters:

Name Type Description Default
extension str

Extension without the leading dot.

 required

Returns:

Name Type Description
SpaceTrackEphemerisFileName SpaceTrackEphemerisFileName

The updated name.

Raises:

Type Description
BraheError

If extension is empty or contains _, ., /, a backslash or NUL.

SpaceTrackEphemerisFileCategory

SpaceTrackEphemerisFileCategory 

SpaceTrackEphemerisFileCategory()

Whether an ephemeris file is Operational or Special.

Space-Track accepts one Operational file per satellite at a time and any number of Special (planning) files.

Example 
1
2
3
4
import brahe as bh

category = bh.SpaceTrackEphemerisFileCategory.parse("oper")
assert category == bh.SpaceTrackEphemerisFileCategory.OPERATIONAL

Initialize instance.

OPERATIONAL class-attribute 

OPERATIONAL: Any = SpaceTrackEphemerisFileCategory.OPERATIONAL

Whether an ephemeris file is Operational or Special.

Space-Track accepts one Operational file per satellite at a time and any number of Special (planning) files.

Example 
1
2
3
4
import brahe as bh

category = bh.SpaceTrackEphemerisFileCategory.parse("oper")
assert category == bh.SpaceTrackEphemerisFileCategory.OPERATIONAL

SPECIAL class-attribute 

SPECIAL: Any = SpaceTrackEphemerisFileCategory.SPECIAL

Whether an ephemeris file is Operational or Special.

Space-Track accepts one Operational file per satellite at a time and any number of Special (planning) files.

Example 
1
2
3
4
import brahe as bh

category = bh.SpaceTrackEphemerisFileCategory.parse("oper")
assert category == bh.SpaceTrackEphemerisFileCategory.OPERATIONAL

parse staticmethod 

parse(token: str) -> SpaceTrackEphemerisFileCategory

Parse the category field of a file name.

Any token starting with oper is Operational and any token starting with special is Special, case-insensitively.

Parameters:

Name Type Description Default
token str

Category field of a file name.

 required

Returns:

Name Type Description
SpaceTrackEphemerisFileCategory SpaceTrackEphemerisFileCategory

The parsed category.

Raises:

Type Description
BraheError

If the token is not a recognized category.

See Also