Welcome to the Vino API

Vino API is an URL based system to get and post information about Ryzom that are not covered by the official API.

Base URL

All requests are using https://api.vino.bierdosenhalter.de as base url.

Input URLs

The URLs listed under POST are used by some RCC Client plugins to post ingame data.

Auth Keys

Auth keys are provided by In Vino Veritas.

GET

Player Online Status

Base URL

/plonsta.php

Database

api_char_status

URL Parameters

from

(optional) [s] created_at >= value

to

(optional) [s] created_at < value

name

(optional)

• [not set]: Returns JSON that contains all distinct character names in the timespan.
• character name: Returns JSON that contains a maximum of 1000 last online status changes of the character in the timespan.

JSON structure

[
    {
        "created_at": 1699773689,
        "name": "aalon",
        "status": "offline"
    },
    {
        "created_at": 1699773304,
        "name": "aalon",
        "status": "unknown"
    },
    ...
]

Player And Faction Counter

Base URL

/plafaco.php

Database

api_char_online_count

URL Parameters

from

(optional) [s] default: to - 86400 * 7

created_at < value

to

(optional) [s] default: time()

created_at > value

modul

(optional) [s] default: 3600 minimum: 3600

grouped by created_at / modul

limited by 1000 entries

JSON structure

[
    {
        "created_at": 1704844800,
        "chars_known": 4443,
        "chars_online_min": 16,
        "chars_online_avg": 41.007,
        "chars_online_max": 92,
        "faction_kami": 15.411,
        "faction_marauder": 8.619,
        "faction_ranger": 2.867,
        "faction_karavan": 4.992,
        "faction_neutral": 0.394,
        "faction_unknown": 8.724,
        "count": 1208
    },
    ...
]

POST

Search Players

Base URL

/seaplr.php

Database

vinoapp_player_db

Posted JSON Parameters

auth

Auth Token

name

Name of the player to look up (exact match first, then partial match, max 10 results).

include_history

(optional) Set to true to include recent guild membership history.

JSON structure

{
    "query": "Beefy",
    "match": "exact",
    "player": {
        "name": "Beefy",
        "race": "Fyros",
        "faction": "Kami",
        "cult": "Kami",
        "language": "fra",
        "guild": {
            "name": "Bovine Intervention",
            "id": 123,
            "rank": "Officer",
            "open_guild": false
        },
        "known_since": "2023-11-12T10:01:29Z"
    }
}

If the name matches multiple players, match is "ambiguous" and the response contains a candidates list of name/id pairs instead of a player.

Search Guilds

Base URL

/seagld.php

Database

vinoapp_guilds

Posted JSON Parameters

auth

Auth Token

name

Name of the guild to look up (exact match first, then partial match, max 10 results).

include_members

(optional) Default: true. Set to false to omit the member roster.

include_history

(optional) Set to true to include recent join/leave events.

JSON structure

{
    "query": "Bovine Intervention",
    "match": "exact",
    "guild": {
        "name": "Bovine Intervention",
        "id": 123,
        "icon_id": 45,
        "created_at": "2023-11-12T10:01:29Z",
        "race": "Fyros",
        "faction": "Kami",
        "description": "...",
        "whitelisted": false,
        "member_count": 42
    },
    "members": [
        {
            "name": "Beefy",
            "rank": "Officer",
            "joined": "2024-01-05"
        },
        ...
    ]
}

If the name matches multiple guilds, match is "ambiguous" and the response contains a candidates list of name/id pairs instead of a guild.

Outpost Info Collector

Base URL

/ouinco.php

Database

api_outposts

Posted JSON File Parameters

auth

Auth Token

outpost

Information dictionary about the outpost:

• sheetname: sheet name
• level: level
• status: status
• stateenddate: state_end_date
• displaycrash: display_crash
• warcost: warcost
• guildname: guild_name
• guildicon: guild_icon
• guildtribe: guild_tribe
• guildnameatt: guild_name_att
• roundlvlthreshold: round_lvl_threshold
• roundlvlmaxatt: round_lvl_max_att
• roundlvlmaxdef: round_lvl_max_def
• roundlvlcur: round_lvl_cur
• roundidcur: round_id_cur
• roundidmax: round_id_max
• timerangedefwanted: time_range_def_wanted
• timerangedef: time_range_def
• timerangeatt: time_range_att
• timerangelength: time_range_length

Returns

1 if the post was successful.

Player Info Collector

Base URL

/plinco.php

Database

vinoapp_player_db

Posted JSON File Parameters

auth

Auth Token

players

List of players around the character:

• name: Name of the player.
• guild: Guild name of the player.

Returns

1 if the post was successful.

Player Status And Faction Counter

Base URL

/pryzm.php

Databases

api_char_status

api_char_online_count

Posted JSON File Parameters

auth

Auth Token

players

List of players around the character:

• name: Name of the player.
• status: 1 for online and 2 for offline.

Returns

1 if the post was successful.

Marauder Boss Status

Base URL

/boinco.php

Database

vinoapp_marauder_bosses

Posted JSON File Parameters

auth

Auth Token

entities

List of entities around the character:

• name: Name of the entity.
• sheet: SheetID name (e.g. "zorai.race_stats").
• attackable: "True", if the entity is attackable.

Returns

1 if the post was successful.