API Documentation

Discover Spacetime APIs: how to connect to them, their functionality, and how to use them to orchestrate your network.

Spacetime offers 3 APIs:

  1. The Northbound Interface (NBI) allows humans or applications to define and orchestrate a network. This includes functions such as specifying the time-dynamic position and orientation of platforms and antennas, defining networking parameters on each node in the network, and creating requests for service that will be scheduled and routed through the network. Learn more
  2. The Southbound Interface (SBI) is the collection of services through which devices participating in the network communicate with Spacetime. This includes services through which these devices may receive schedule updates from Spacetime, and through which they may push metrics and observations to Spacetime. Learn more
  3. The Federation API, or East-West Interface, allows peer networks to request and to supply network resources and interconnections between partners’ networks. This facilitates dynamic, real-time inter-network connections, which allows operators to automatically and quickly supplement gaps in network coverage or advertise unused capacity to make full use of underutilized assets. Learn more

Getting Started

Authentication

API Guides

Northbound API (NBI) Southbound API (SBI) Federation API

Access the APIs

Find the Spacetime APIs in the Github repository

Spacetime’s APIs are built on Protocol Buffers, a language-agnostic format and toolchain for serializing messages, and gRPC, a performant RPC framework with many sophisticated features.