https://github.com/dderevjanik/pixabay-api
pixabay api, https://pixabay.com/api/docs/
https://github.com/dderevjanik/pixabay-api
free-images pixabay pixabay-api typescript
Last synced: about 1 month ago
JSON representation
pixabay api, https://pixabay.com/api/docs/
- Host: GitHub
- URL: https://github.com/dderevjanik/pixabay-api
- Owner: dderevjanik
- License: mit
- Created: 2017-06-27T21:34:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-29T07:51:44.000Z (6 months ago)
- Last Synced: 2025-08-15T23:06:38.036Z (about 2 months ago)
- Topics: free-images, pixabay, pixabay-api, typescript
- Language: TypeScript
- Homepage:
- Size: 68.4 KB
- Stars: 27
- Watchers: 2
- Forks: 10
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pixabay-api
All images and videos on Pixabay are released free of copyrights under Creative Commons CC0. You may download, modify, distribute, and use them royalty free for anything you like, even in commercial applications. Attribution is not required.
Pixabay API docs: [https://pixabay.com/api/docs/](https://pixabay.com/api/docs/)
## Installation
```bash
npm install pixabay-api
```
In order to get result of `searchImages` or `searchVideos` you need authenticate key,
which can be obtained by [sign up on pixabay.com](https://pixabay.com/en/accounts/register/)
## Examples
### `searchImages(key, query, options, validate = true)`
Basic example
```js
import { searchImages } from 'pixabay-api';
searchImages(AUTH_KEY, 'puppy').then((r) => console.log(r));
// { totalHits: 500,
// hits:
// [ { previewHeight: 99,
// likes: 108,
// favorites: 87,
// tags: 'chihuahua, dog, puppy',
// webformatHeight: 426,
// views: 38770,
// webformatWidth: 640,
// previewWidth: 150,
// comments: 17,
// downloads: 11050,
// pageURL: 'https://pixabay.com/en/chihuahua-dog-puppy-cute-pet-621112/',
// previewURL: 'https://cdn.pixabay.com/photo/2015/02/02/17/06/chihuahua-621112_150.jpg',
// webformatURL: 'https://pixabay.com/get/ef37b00e29f61c2ad65a5854e34b4294e277eac818b5184993f0c07fafe9_640.jpg',
// imageWidth: 5184,
// user_id: 740400,
// user: 'Teerasuwat',
// type: 'photo',
// id: 621112,
// userImageURL: 'https://cdn.pixabay.com/user/2015/02/02/17-19-43-530_250x250.jpg',
// imageHeight: 3456 },
// ...
// ],
// total: 3343
// }
```
Bad values for some props will throw an error
```js
await searchImages(AUTH_KEY, 'puppy', {per_page: 203});
// will throw an error:
// Error: Request.per_page: '203', but accepted values 3 - 200
```
To suppress those errors, turn off validation
```js
await searchImages(AUTH_KEY, 'puppy', {per_page: 203}, false);
// Will return bad http request, no error
```
with **Authenticate** you no longer need to add auth_key within `searchImages`
```js
import { authenticate } from 'pixabay-api';
const { searchImages, searchVideos } = authenticate(AUTH_KEY);
await searchImages('puppy'); // no need to add auth_key
await searchImages('birthday cake', {per_page: 20}); // no need to add auth_key
await searchVideos('dog'); // no need to add auth key
```
### `searchVideos(key, query, options, validate = true)`
Searching for videos has same interface as `searchImages`
```js
import { searchVideos } from 'pixabay-api';
searchVideos(AUTH_KEY, 'puppy');
```
## FAQ
### How to obtain Authenticate Key ?
[sign up on pixabay.com](https://pixabay.com/en/accounts/register/)
### I cannot get response from searchImages or searchVideos
Probably you forget to add *auth_key* or you have bad one. First, make
sure that you have right *auth_key* by pasting this code (with your auth_key)
`https://pixabay.com/api/?key={ KEY }&response_group=high_resolution&q=yellow+flower`
in browser, you should see response similar to one in Example section.
### How to retrieve high resolution images ?
[request full api access](https://pixabay.com/api/docs/#api_support)