igdb_parameters: igdb_parameters helps you convert your request to...

Description Usage Arguments Value Examples

View source: R/Parameters.R

Description

igdb_parameters helps you convert your request to queryparameters that the api can read.

Usage

1
2
3
igdb_parameters(fields = "", limit = 10, offset = 0, order = "",
  ids = "", expand = "", search = "", filter = list(),
  query = "")

Arguments

fields

enter the fields you want to see

limit

limit sets the response limit, default is 10

offset

offset set the response offset, default is 0

order

order sets the default ordering of your response

ids

displays items with the specific id WARNING cannot be used together with search

expand

expand sets the fields you want expanded in the response

search

search is a text based search search for titles WARNING cannot be used together with ids

filter

filter sets the specific filters to your response ex: list("[genre][eq]=33"). adding multiple filters will AND then in the response

query

query replaces ALL other params and is intended for raw queryparams

Value

a complete and valid queryParameter for use with your request.

Examples

1
2
3
4
5
igdb_parameters(fields = "id,name,genres.name", order = "name:desc", expand = "genres")
igdb_parameters(search = "Zelda", fields = "id,name,genres.name", order = "name:desc", expand = "genres")
igdb_parameters(ids = "1,23,33,42", fields = "*", expand = "genres")
igdb_parameters(query = "?fields=id,name&limit=33&order=name:desc")
igdb_parameters(fields = "name,genres.name,release_dates.human,release_dates.date,first_release_date" filter = list("[first_release_date][gt]=1508243168000", "[themes][not_in]=42", "[cover][exists]"))

igdb/igdb-api-r documentation built on Sept. 16, 2021, 2:29 a.m.