live games in progress / API

hughb · May 12, 2025, 9:09am

Hi All,

I would like to develop a python script to download all live games in progress, particularly I want to count user rankings so I can see a chart of when I have the best chance of getting games at different parts of the day.

My thoughts are to download the current list in progress every 10 minutes, build an array that counts the number of players at each K or Dan level and then work out the average per rank per hour over a 7 day period.

I have looked at the API documentation.

I have tried

https://online-go.com/api/v1/ui/overview/

But I am just getting the following back

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "active_games": [],
    "challenges": []
}

Many Thanks

benjito · May 12, 2025, 11:02am

Overview is just your home page. As you can see from the api call, it’s mainly just returning (your) active games.

You might need to use websocket to query the games-in-progress list. Please see how OGS does it:

github.com

online-go/online-go.com/blob/41b4d10e3306a9b1f67026f931acb5734e9d9d4a/src/components/ObserveGamesComponent/ObserveGamesComponent.tsx#L221


      
          if (filter.friend_games_only) {
              delete filter.friend_games_only;
              try {
                  filter.players = data.get("cached.friends")?.map((friend: any) => friend.id);
              } catch (e) {
                  console.error(e);
              }
          }
          
          socket.send(
              "gamelist/query",
              {
                  list: this.state.viewing,
                  sort_by: "rank",
                  where: filter,
                  from: ((this.state.page as number) - 1) * this.state.page_size,
                  limit: this.state.page_size,
                  channel: this.channel,
              },
              (res) => {
                  if (!res) {

a chart of when I have the best chance of getting games at different parts of the day.

btw, this sounds super useful, please share what you find!

hughb · May 12, 2025, 11:11am

I have checked the docs again and it needs an auth token.
So far I have not managed to get my registered client / client secret to authorise.
I have raised various queries but have not seen any answers.

I will check again.

benjito · May 12, 2025, 11:22am

Even if you figure out the auth token, that endpoint doesn’t have the information you’re looking for.

hughb · May 12, 2025, 12:09pm

Yes - so I have descovered.

I have managed to get the OGSclient import working.
Here’s my basic code:


from ogsapi.client import OGSClient

# change these 

client_id = 'xxx'
client_secret = 'xxx'
username = 'myogs_account_username'
password = 'myogs_account_password'

ogs = OGSClient(client_id, client_secret, username, password)

print(ogs)


vitals = ogs.user_vitals()
print(vitals)

endpoint = f'/ui/overview'
my_games = ogs.api.call_rest_endpoint('GET', endpoint=endpoint).json()

print(my_games)

Just need the right endpoint for giving me a list of all the current live games.

benjito · May 12, 2025, 12:46pm

If you’re using OGSClient library, you’ll want to use its ogssocket class and send/observe “gamelist/query” and “gamelist/count” messages.

hughb · May 12, 2025, 4:09pm

I’m not sure how to code the OGSClient to use a event handler for the sockets.
I have had a look at the example code.

github.com

dakota-marshall/python-ogs/blob/main/example.py

import dotenv
import os
import sys
from loguru import logger
from src.ogsapi.client import OGSClient
from typing import Callable

# Prep variables
dotenv.load_dotenv()
client_id = os.getenv('OGS_CLIENT_ID')
client_secret = os.getenv('OGS_CLIENT_SECRET')
username = os.getenv('OGS_USERNAME')
password = os.getenv('OGS_PASSWORD')

# Basic example class for handling the game object received from the wrapper
# This doesnt have to be a class, but because of the callback function requirement,
# its easier to manage multiple games this way.

def ogs_event_handler(event_name: str, data: dict):
  print(f"Got Event: {event_name} with data: {data}")

This file has been truncated. show original

What I dont understand is how I setup the socket and handler and then keep the python code running so that the handler gets called while the code keeps running.
Do I just do something like

ogs.socket_connect(ogs_event_handler)

sleep(1 hour) # allow handler to be called

ogs.socket_disconnect()

hughb · May 17, 2025, 10:48am

Anyone any suggestions how to code an event handler in python to capture the ranks of players in current games

benjito · May 17, 2025, 12:44pm

You can probably do something like ogs.sock.wait(). Most socket libraries provide a way to run the event loop. But i just realized that library OGSClient is using socket.io. OGS moved away from that. You should open a bug report if you run into issues, or you may have better luck using the built-in websockets library.

keep in mind, this is a Go forum. For general Python questions like “how to wait for a socket response” you’ll probably be better served by asking StackOverflow or LLM or a Python-centric forum