https://github.com/axsddlr/rpilocator_api

An Unofficial REST API for checking Raspberry Pi 4 availability https://rpilocator.com/
https://github.com/axsddlr/rpilocator_api

fastapi python rest-api web-scraping

Last synced: 5 days ago
JSON representation

An Unofficial REST API for checking Raspberry Pi 4 availability https://rpilocator.com/

• Host: GitHub
• URL: https://github.com/axsddlr/rpilocator_api
• Owner: axsddlr
• License: mit
• Created: 2022-04-20T06:48:16.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-25T16:25:07.000Z (over 2 years ago)
• Last Synced: 2024-08-01T15:33:50.253Z (3 months ago)
• Topics: fastapi, python, rest-api, web-scraping
• Language: Python
• Homepage: https://rpilocator-api.vercel.app
• Size: 17.6 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rpilocator api

### (for Raspberry Pi 4 Model B only)

An Unofficial REST API for [rpilocator.com](https://rpilocator.com/)

Built by [Andre Saddler](https://github.com/axsddlr/)

[![heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

## Current Endpoints

### `/pi4/`

- Method: `GET`

- Cached Time: 300 seconds (5 Minutes)

- Region: `US`, `UK`

- Response:

### `/pi4//`

- Method: `GET`

- Cached Time: 300 seconds (5 Minutes)

- Region: `1`, `2`, `4`, `8`

## Installation

### Source

```

$ git clone https://github.com/axsddlr/rpilocator_api/

$ cd rpilocator_api

$ pip install -r requirements.txt

```

### Usage

```

python3 main.py

OR 

uvicorn main:app --reload --port 3000

```

## Contributing

Feel free to submit a [pull request](https://github.com/rehkloos/vlrggapi/pull/new/master) or an [issue](https://github.com/rehkloos/vlrggapi/issues/new)!

## License

The MIT License (MIT)