Skip to content

Latest commit

 

History

History
154 lines (101 loc) · 6.7 KB

faq_SNAPI.md

File metadata and controls

154 lines (101 loc) · 6.7 KB

SNAPI Cover

Website Documentation Discord

Spaceflight News API - Frequently Asked Questions (FAQ)

Table of Contents

About

What is the Spaceflight News API (SNAPI)?

The Spaceflight News API is a REST API providing space news data including :

  • Space-related news articles from numerous websites
  • Space-related blog posts from numerous websites
  • Daily summary reports from the International Space Station

Is SNAPI still under development?

SNAPI is still maintained and improved regularly. However, most of the upgrades are related to the news sources or backend improvements, requiring no version bump. New features or data can also be added without bumping the API version if they are fully compatible.

When a new version is released, the announcement will be made the on the TSD Discord server and Twitter (TSD , SNAPI) first.

Free and paid access

Is SNAPI free to use?

Yes, SNAPI is fully free to use for everyone. However, if you are using SNAPI in a commercial project, we would appreciate if you consider supporting the project through Patreon or a one-time donation.

Do I need an API key?

No API key is required to use SNAPI.

Data

What data is available?

A list of the main data elements available through SNAPI is available on its website. The full list of endpoints is available in the documentation.

Where does SNAPI get its data from?

When available, the data is imported from RSS feeds or the API of source websites. Otherwise, it is acquired through automatic web scraping. Some basic filters are applied during processing to remove irrelevant data.

How often is the data updated?

The importer runs every 10 minutes to check for new data, so new articles can take up to 10 minutes to appear in the API.

What date/time format is used in SNAPI?

All the datetime fields in SNAPI follow the ISO 8601 format, for example 2022-10-16T07:21:04.448ZZ. All times are UTC, as indicated by the Z at the end of the datetime string.

Which types of news sources are allowed in SNAPI?

All professional space-related news sources are allowed in SNAPI for the articles endpoint. For the blogs endpoint, high-quality amateur content is also allowed.

It is possible to suggest new sources to be added to SNAPI by posting in the 💬feedback-and-help forum of the TSD Discord server.

How is the data linked to other APIs?

Articles are linked to Launch Library 2 launches and events through their LL2 ID.

API

How to filter the API response?

Filters can be applied to an API query by adding ?<filter>=<value> to the end of the query.

For example: https://api.spaceflightnewsapi.net/v4/articles?title_contains=NASA

How to apply multiple filters?

Multiple filters can be applied by separating them with &.

For example: https://api.spaceflightnewsapi.net/v4/articles/?title_contains=NASA&published_at_lte=2022-01-01

How to get more results in a single request?

It is possible to increase the number of results per request by using the limit=<number> filter.

How to paginate through the data?

The API supports pagination through the offset=<number> filter. This filter is automatically applied to the request URL and provided in the next field of the response.

How to sort the API response?

The API response can be sorted by any of the available fields using ordering=<field>. Use -<field> to sort in descending order.

Help & Contact

Where do I get help?

If you need any help with SNAPI, you can ask in the 💬feedback-and-help forum of the TSD Discord server or email derk@spaceflightnewsapi.net.

How do I report a bug/data mistake?

If you found a bug or data mistake, let the staff know in the 💬feedback-and-help forum of the TSD Discord server, or email derk@spaceflightnewsapi.net.

How do I contact the SNAPI staff?

There are two main ways to contact the SNAPI staff: