Skip to content

Commit 03f4bc4

Browse files
committed
Update documentation
1 parent a0d4f02 commit 03f4bc4

3 files changed

Lines changed: 5 additions & 43 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# BDO-REST-API
2-
Scraper for Black Desert Online community data with a built-in API server. It currently supports EU, NA, SA and KR regions.
2+
Scraper for Black Desert Online community data with a built-in API server. It currently supports EU, NA, SA and KR regions. Support for other regions might be added in the future.
33

44
## Projects using this API
5-
- BDO Leaderboards ([Website](https://bdo.hemlo.cc/leaderboards), [sources](https://github.com/man90es/BDO-Leaderboards)): web-based leaderboards for Black Desert Online.
5+
- ~~BDO Leaderboards ([Website](https://bdo.hemlo.cc/leaderboards), [sources](https://github.com/man90es/BDO-Leaderboards)): web-based leaderboards for Black Desert Online.~~
66
- Ikusa ([Website](https://ikusa.site), [sources](https://github.com/sch-28/ikusa_api)): powerful tool that allows you to analyze your game logs and gain valuable insights into your combat performance.
77
- GuildYapper ([Discord server](https://discord.gg/x2nKYuu2Z2)): Discord bot with various features for BDO guilds such as guild and player history logging, and automatic trial Discord management (more features TBA).
88
- BDO Guild Bosses - Alliance [EU] ([Discord server](https://discord.gg/735bYrQWKr)): Discord bot for organising events in a guild bosses alliance.
9-
- Cute Papus! ([Website](https://cutepap.us/)): A collection of various BDO-related tools in a single web app.
9+
- Cute Papus! ([Website](https://cutepap.us)): A collection of various BDO-related tools in a single web app.
1010

1111
## How to start using it
1212
There are two ways to use this scraper for your needs:
13-
* By querying https://bdo.hemlo.cc/communityapi/v1 — this is the "official" instance hosted by me.
13+
* By querying https://community-api.cutepap.us/v1 — this is the "official" instance hosted by me.
1414
* If you want to have more control over the API, host the scraper yourself using one of the following methods:
1515
- As a Docker container: the image is available on [DockerHub](https://hub.docker.com/r/man90/bdo-rest-api).
1616
- Natively: build the binary from source as described in [this guide](docs/buildingFromSource.md).

docs/migrationGuide.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"servers": [
88
{
9-
"url": "https://bdo.hemlo.cc/communityapi"
9+
"url": "https://community-api.cutepap.us"
1010
},
1111
{
1212
"url": "http://localhost:8001"

0 commit comments

Comments
 (0)