See stapiEntities
for all the currently available API entities. These are the IDs for dataset collections or categories passed to id
.
The universal ID uid
can be supplied to retrieve a more specific subset of data. By default, uid = NULL
and stapi
operates in search mode.
As part of a stepwise process, you can first use search mode.
Then if the resulting data frame includes a uid
column, you can make a second call to the function providing a specific uid
.
This puts stapi
into extraction mode and will return satellite data associated with the unique entry from the original general sweep of the entity id
.
rtrek
employs anti-DDOS measures. It will not perform an API call to STAPI more than once per second.
To be an even better neighbor, you can increase this wait time using options
, e.g. options(rtrek_antiddos = 10)
to increase the minimum time between API calls to ten seconds.
Values less than one are ignored (defaulting back to one second) and a warning will be thrown when making any API call if this is the case.
Currently STAPI contains primarily real world data such as episode air dates, movie metadata, or production company information. Fictional world data is secondary and more limited.