Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TimothyYe/bing-wallpaper
A RESTful API to fetch daily wallpaper from Bing.com
https://github.com/TimothyYe/bing-wallpaper
bing-wallpaper bing-wallpaper-api
Last synced: 2 months ago
JSON representation
A RESTful API to fetch daily wallpaper from Bing.com
- Host: GitHub
- URL: https://github.com/TimothyYe/bing-wallpaper
- Owner: TimothyYe
- License: apache-2.0
- Created: 2018-11-19T04:53:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T15:42:41.000Z (3 months ago)
- Last Synced: 2024-11-07T13:13:06.409Z (2 months ago)
- Topics: bing-wallpaper, bing-wallpaper-api
- Language: Go
- Homepage: https://bing.biturl.top/
- Size: 2.74 MB
- Stars: 355
- Watchers: 5
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome - TimothyYe/bing-wallpaper - A RESTful API to fetch daily wallpaper from Bing.com (Go)
README
## Bing Wallpaper API
A RESTful API to fetch daily wallpaper from Bing.com
## Usage
### API
* API Address: [https://bing.biturl.top](https://bing.biturl.top/)
* Method: `HTTP GET`
### Parameters
* `format` The response format, can be `json` or `image`. __If response format is set as `image`, you will be redirected to the wallpaper image directly__.
* `image_format` The format of the wallpaper image, available values are `jpg` or `webp`. The default value is `jpg`.
* `index` The index of wallpaper, starts from 0. By default, `0` means to get today's image, `1` means to get the image of yesterday, and so on. Or you can specify it as `random` to choose a random index between 0 and 7.
* `mkt` The region parameter, the default value is `zh-CN`, you can also use `en-US`, `ja-JP`, `en-AU`, `en-GB`, `de-DE`, `en-NZ`, `en-CA`. Alternatively, you can set it as `random` to choose the region randomly.
* `resolution` The resolution of wallpaper image. `1920` is the default value, you can also use `1366` and `3840` or `UHD` (4K resolution).
The available resolution options are listed below:
```
UHD
1920x1200
1920x1080
1366x768
1280x768
1024x768
800x600
800x480
768x1280 (Portrait mode)
720x1280 (Portrait mode)
640x480
480x800 (Portrait mode)
400x240
320x240
240x320 (Portrait mode)
```
### Example
* Request
```text
https://bing.biturl.top/?resolution=UHD&format=json&index=0&mkt=zh-CN
```
* Response
```json
{
"start_date": "20240803",
"end_date": "20240804",
"url": "https://www.bing.com/th?id=OHR.ImpalaOxpecker_ZH-CN9652434873_UHD.jpg",
"copyright": "黑斑羚和红嘴牛椋鸟，南非 (© Matrishva Vyas/Getty Images)",
"copyright_link": "https://www.bing.com/search?q=%E5%8F%8B%E8%B0%8A%E6%97%A5&form=hpcapt&mkt=zh-cn"
}
```
### CSS background image
You can also use this API to set CSS background image:
```text
background-image: url(https://bing.biturl.top/?resolution=1920&format=image&index=0&mkt=zh-CN);
height: 100%;
background-position: center;
background-repeat: no-repeat;
background-size: cover;
```
__Demo__
[https://biturl.top](https://biturl.top)
## Run with docker
Get the latest version of docker image:
```bash
docker pull timothyye/bing:latest
```
Start the container with the image name & tag (YYYYMMDD or latest), for example:
```bash
docker run -d --name=bing-wallpaper --restart=always -p 9000:9000 timothyye/bing:latest
```
## For development
### Build it
```bash
git clone https://github.com/TimothyYe/bing-wallpaper.git
make build
```
### Run it
```bash
bw/bw run
```