Skip to content

Commit 56564a1

Browse files
NosudrumNosudrum
committed
Update faq_SNAPI.md
1 parent 918f680 commit 56564a1

1 file changed

Lines changed: 143 additions & 2 deletions

File tree

‎faqs/faq_SNAPI.md‎

Lines changed: 143 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,152 @@
11
![SNAPI Cover](../assets/snapi_poster.png)
22

33
[![Website](https://raw.githubusercontent.com/TheSpaceDevs/Tutorials/b475617700544896da25f3dbf70857c111d93299/assets/badge_snapi_website.svg)](https://spaceflightnewsapi.net/)
4-
[![Documentation](https://raw.githubusercontent.com/TheSpaceDevs/Tutorials/b475617700544896da25f3dbf70857c111d93299/assets/badge_snapi_doc.svg)](https://api.spaceflightnewsapi.net/v3/documentation)
4+
[![Documentation](https://raw.githubusercontent.com/TheSpaceDevs/Tutorials/b475617700544896da25f3dbf70857c111d93299/assets/badge_snapi_doc.svg)](https://api.spaceflightnewsapi.net/documentation)
55
[![Discord](https://img.shields.io/badge/Discord-%237289DA.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/p7ntkNA)
66

77
# Spaceflight News API - Frequently Asked Questions (FAQ)
88

99
## Table of Contents
1010

11-
<!-- Start TOC (do not remove me) -->
11+
<!-- Start TOC (do not remove me) -->
12+
13+
* [About](#about)
14+
* [What is the *Spaceflight News API* (SNAPI)?](#what-is-the-spaceflight-news-api-snapi)
15+
* [Is SNAPI still under development?](#is-snapi-still-under-development)
16+
* [Free and paid access](#free-and-paid-access)
17+
* [Is SNAPI free to use?](#is-snapi-free-to-use)
18+
* [Do I need an API key?](#do-i-need-an-api-key)
19+
* [Data](#data)
20+
* [What data is available?](#what-data-is-available)
21+
* [Where does SNAPI get its data from?](#where-does-snapi-get-its-data-from)
22+
* [How often is the data updated?](#how-often-is-the-data-updated)
23+
* [What date/time format is used in SNAPI?](#what-datetime-format-is-used-in-snapi)
24+
* [Which types of news sources are allowed in SNAPI?](#which-types-of-news-sources-are-allowed-in-snapi)
25+
* [How is the data linked to other APIs?](#how-is-the-data-linked-to-other-apis)
26+
* [API](#api)
27+
* [How to filter the API response?](#how-to-filter-the-api-response)
28+
* [How to apply multiple filters?](#how-to-apply-multiple-filters)
29+
* [How to apply filters with multiple values?](#how-to-apply-filters-with-multiple-values)
30+
* [How to get more results in a single request?](#how-to-get-more-results-in-a-single-request)
31+
* [How to paginate through the data?](#how-to-paginate-through-the-data)
32+
* [How to sort the API response?](#how-to-sort-the-api-response)
33+
* [Help & Contact](#help--contact)
34+
* [Where do I get help?](#where-do-i-get-help)
35+
* [How do I report a bug/data mistake?](#how-do-i-report-a-bugdata-mistake)
36+
* [How do I contact the SNAPI staff?](#how-do-i-contact-the-snapi-staff)
37+
38+
## About
39+
40+
> ### What is the *Spaceflight News API* (SNAPI)?
41+
42+
The Spaceflight News API is a REST API providing space news data including :
43+
44+
- Space-related news articles from numerous websites
45+
- Space-related blog posts from numerous websites
46+
- Daily summary reports from the International Space Station
47+
48+
> ### Is SNAPI still under development?
49+
50+
SNAPI is still maintained and improved regularly. However, most of the upgrades are related to the news sources or
51+
backend improvements, requiring no version bump. New features or data can also be added without bumping the API
52+
version if they are fully compatible.
53+
54+
When a new version is released, the announcement will be made the on the
55+
TSD [Discord server](https://discord.gg/p7ntkNA) and Twitter ([TSD](https://twitter.com/TheSpaceDevs)
56+
, [SNAPI](https://twitter.com/the_snapi)) first.
57+
58+
## Free and paid access
59+
60+
> ### Is SNAPI free to use?
61+
62+
Yes, SNAPI is fully free to use for everyone. However, if you are using SNAPI in a commercial project, we would
63+
appreciate if you consider supporting the project through [Patreon](https://www.patreon.com/thespacedevs) or a
64+
one-time [donation](https://ko-fi.com/derkweijers).
65+
66+
> ### Do I need an API key?
67+
68+
No API key is required to use SNAPI.
69+
70+
## Data
71+
72+
> ### What data is available?
73+
74+
A list of the main data elements available through SNAPI is available on its [website](https://spaceflightnewsapi.net/).
75+
The full list of endpoints is available in the [documentation](https://api.spaceflightnewsapi.net/documentation).
76+
77+
> ### Where does SNAPI get its data from?
78+
79+
When available, the data is imported from RSS feeds or the API of source websites.
80+
Otherwise, it is acquired through automatic web scraping.
81+
Some basic filters are applied during processing to remove irrelevant data.
82+
83+
84+
> ### How often is the data updated?
85+
86+
:warning: ???
87+
88+
> ### What date/time format is used in SNAPI?
89+
90+
All the datetime fields in SNAPI follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, for example
91+
`2022-10-16T07:21:04.448ZZ`. All times are UTC, as indicated by the `Z` at the end of the datetime string.
92+
93+
> ### Which types of news sources are allowed in SNAPI?
94+
95+
All professional space-related news sources are allowed in SNAPI for the `articles` endpoint.
96+
For the `blogs` endpoint, high-quality amateur content is also allowed.
97+
98+
It is possible to suggest new sources to be added to SNAPI by posting in the
99+
[`💬feedback-and-help`](https://discord.com/channels/676725644444565514/1019976345884827750) forum of the TSD
100+
[Discord server](https://discord.gg/p7ntkNA).
101+
102+
> ### How is the data linked to other APIs?
103+
104+
Articles are linked to [Launch Library 2](https://thespacedevs.com/llapi) launches and events through their LL2 ID.
105+
106+
## API
107+
108+
> ### How to filter the API response?
109+
110+
Filters can be applied to an API query by adding `?<field>_<filter>=<value>` to the end of the query.
111+
112+
For example: https://api.spaceflightnewsapi.net/v3/articles?title_contains=NASA
113+
114+
> ### How to apply multiple filters?
115+
116+
Multiple filters can be applied by separating them with `&`.
117+
118+
For example: https://api.spaceflightnewsapi.net/v3/articles?title_contains=NASA&publishedAt_lte=2022-01-01
119+
120+
121+
> ### How to get more results in a single request?
122+
123+
It is possible to increase the number of results per request by using the `_limit=<number>` filter.
124+
125+
> ### How to paginate through the data?
126+
127+
The API supports pagination through the `_start=<number>` filter.
128+
129+
> ### How to sort the API response?
130+
131+
The API response can be sorted by any of the available fields using `_sort=<field>`.
132+
133+
## Help & Contact
134+
135+
> ### Where do I get help?
136+
If you need any help with SNAPI, you can ask in the
137+
[`💬feedback-and-help`](https://discord.com/channels/676725644444565514/1019976345884827750) forum of the TSD
138+
[Discord server](https://discord.gg/p7ntkNA) or email [derk@spaceflightnewsapi.net](mailto:derk@spaceflightnewsapi.net).
139+
140+
> ### How do I report a bug/data mistake?
141+
142+
If you found a bug or data mistake, let the staff know in the
143+
[`💬feedback-and-help`](https://discord.com/channels/676725644444565514/1019976345884827750) forum of the TSD
144+
[Discord server](https://discord.gg/p7ntkNA), or
145+
email [derk@spaceflightnewsapi.net](mailto:derk@spaceflightnewsapi.net).
146+
147+
> ### How do I contact the SNAPI staff?
148+
149+
There are two main ways to contact the SNAPI staff:
150+
151+
- On the [Discord server](https://discord.gg/p7ntkNA).
152+
- By email to [derk@spaceflightnewsapi.net](mailto:derk@spaceflightnewsapi.net).

0 commit comments

Comments
 (0)