Skip to content

eltharynd/one-pace-api

Repository files navigation

OnePacerr

One Pace Metadata API

API Status Currently connected

This service periodically scrapes various sources for information and metadata about One Pace releases, and makes them available to the public via Rest API and WebSocket for updates notifications.

Built for OnePacerr, Open for everyone.

*I'm not affiliated with One Pace's team.

🚀 Getting Started

Query the full set at

(GET) https://onepacerr.com/api/v1/metadata

Or read the API docs for an updated list of endpoints:

https://onepacerr.com/api/v1/docs

Or just use the Github Raw url to get the whole data if that works for you

https://raw.githubusercontent.com/eltharynd/one-pace-api/refs/heads/main/output/metadata.json

📡 Live Updates

You can connect via WebSocket to get live updates whenever something changes.

This can be either a new episode is released or metadata is updated.

The easiest way is by installing socket.io-client:

npm i -s socket.io-client

which you can use the following way:

import { io } from 'socket.io-client'

const socket = io('https://onepacerr.com')

socket.on('connect', () => {
  console.log(`Connected with id: '${socket.id}'`)
  socket.emit('subscribe_to_updates')
  //socket.emit('unsubscribe-from-updates')
})

socket.on('disconnect', () => {
  console.log(`Disconnected from server`)
})

socket.on('updates', data => {
  console.log('Update Received', data)
})

Alternatively you can use any other WebSocket Library or even do things manually.

🪄 Under the hood

Scrapes a couple sources every 15 minutes to get the latest information on new releases and metadata:

In order to generate a single complete JSON with all the metadata you could desire.

An copy of that JSON is kept up to date on this very repo:

This is then used by a public Rest API to serve data.

You can find the full list of endpoints in the Swagger API Docs.

🤝 Credits & Acknowledgements

  • One Pace: The incredible team behind the unofficial fan edits.
  • @verywittyname from One Pace's Discord, for maintaining the Episode Dscriptions Google Sheet.
  • @yogobarry from One Pace's Discord, for providing the correct Specials episodes order through the official Jellyfin metadata archive.
  • From an idea by LadyIsatis: Thanks for everything 🙏 but it was time for an update.

💗 Support (One Pace, not me!)

If you want to support the project (costs are very low tbh, just a cheap cloud host and the domain) you can use the sponsor button directly on github, but I'd rather you find a way to support One Pace's team directly instead.

About

One Pace Metadata

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors