python-pixabay
Public Member Functions | Public Attributes | List of all members
pixabay.params.params Class Reference

Pixabay API (unofficial) More...

Public Member Functions

def __init__ (self, host='https://pixabay.com/api/', query='', apiKey='', lang='en', orientation='all', perPage=25, order="popular", safeSearch=False, minWidth=0, minHeight=0, editorsChoice=False, category='all', colors='all', image_type='photo', id=-1)
 Init params object. More...
 

Public Attributes

 host
 
 query
 
 apiKey
 
 lang
 
 orientation
 
 perPage
 
 order
 
 safeSearch
 
 minWidth
 
 minHeight
 
 editorsChoice
 
 category
 
 colors
 
 image_type
 
 id
 

Detailed Description

Pixabay API (unofficial)

Author
Luká¹ Plevaè lukas.nosp@m.@ple.nosp@m.vac.e.nosp@m.u
Date
3.2.2022

Definition at line 6 of file params.py.

Constructor & Destructor Documentation

◆ __init__()

def pixabay.params.params.__init__ (   self,
  host = 'https://pixabay.com/api/',
  query = '',
  apiKey = '',
  lang = 'en',
  orientation = 'all',
  perPage = 25,
  order = "popular",
  safeSearch = False,
  minWidth = 0,
  minHeight = 0,
  editorsChoice = False,
  category = 'all',
  colors = 'all',
  image_type = 'photo',
  id = -1 
)

Init params object.

Parameters
hosthost of API (default: https://pixabay.com/api/)
querysearch words (ex: big tree)
apiKeyapi key for API
langlanguage of search words (default "en") supported: cs, da, de, en, es, fr, id, it, hu, nl, no, pl, pt, ro, sk, fi, sv, tr, vi, th, bg, ru, el, ja, ko, zh
orientationorientation of image (default "all") supported: all, horizontal, vertical
perPagenumber of images per one request (default: 25)
orderorder of images (default: "popular") supported: popular, latest
safeSearcha flag indicating that only images suitable for all ages should be returned (Default: False)
minWidthmin width of image (default: 0)
minHeightmin height of image (default: 0)
editorsChoiceimages that have received an Editor's Choice award (Default: False)
categoryfilter images by category (default: "all") supported: all, backgrounds, fashion, nature, science, education, feelings, health, people, religion, places, animals, industry, computer, food, sports, transportation, travel, buildings, business, music
colorsfilter images by color properties. A comma separated list of values may be used to select multiple properties. (Default: "all") supported: all, grayscale, transparent, red, orange, yellow, green, turquoise, blue, lilac, pink, white, gray, black, brown
Returns
params object

Definition at line 29 of file params.py.


The documentation for this class was generated from the following file: