Description Usage Arguments Details Examples
Retrieve a company or companies from the GiantBomb API.
1 2 3 |
id |
an object id. |
n |
total number of results returned. Defaults to 100. |
field_list |
columns to return. |
limit |
total results per page. Defaults to 100. |
offset |
starting result. |
sort |
arrange results by column. Accepts a string with the format "column:direction". |
filter |
reduce results by column attribute. Accepts a string with the format "column:value". |
user_agent |
allows you to customize the user agent for your requests. See the Details section for more information. |
delay |
the wait time between each query. |
api_key |
a GiantBomb api key. The default searches for GB_KEY in your environment variables. |
An api key can be retrieved for the GiantBomb API after signing up at https://giantbomb.com/api.
GiantBomb limits the query rate to 200 requests per resource per hour.
Additionally, you may experience issues if too many queries are made every
second. Each function attempts to mitigate problems by using a delay after
each query (default is 30 seconds). You can set delay
to 0 if you want to
get the information faster, but GiantBomb may begin to block your requests
if you do this too often.
You may also want to use the user_agent
parameter to customize how your
queries are being received. Doing so can minimize the possibility of
getting a captcha challenges.
Each query returns a maximum of 100 results per request. In order to get
1000 results with a limit
of 100, it would take 10 api requests.
1 2 3 4 5 6 7 8 9 10 11 | ## Not run:
# Get 10 companies.
comp <- gb_companies(n = 10)
# Get a single company with an id.
comp <- gb_companies(id = 360)
# Use filters and sorting.
comp <- gb_companies(filter = "name:2k", sort = "date_added:asc")
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.