Roll20 uses cookies to improve your experience on our site. Cookies enable you to enjoy certain features, social sharing functionality, and tailor message and display ads to your interests on our site and others. They also help us understand how our site is being used. By continuing to use our site, you consent to our use of cookies. Update your cookie preferences .
×

How to access public game information?

Hello! I am new to Roll20, is there a way to go HTTP get to access game information?  Like a standard public API? How do I get an API key for this? Thank you!
1655234127
Gold
Forum Champion
Hello. It depends on which game & what information you want to get from it. The API is available to PRO subscribers of Roll20. Character Vault is a Roll20 feature where you can export / store / acess your Character Sheet data from your Characters in games that you have access to. External Journal is a game setting feature, that the GM-Creator of any game must choose to Opt In if they want it (under Game Settings on game details webpage). This is how you can make parts of your game "public". When the creator has enabled External Journal, then any of the Players who load the External Journal URL of that game will be able to read any of the Handouts that they have in-game access permissions to see. Kinda sounds like you're asking for External Journal, note it is limited to Handouts and Character Bios (does not display Character Sheet data fields other than Bio tab).
Hello Gold, Thank you for the help.&nbsp; I need to explain:&nbsp; &nbsp;From what I was reading so far it doesn't look like its possible. So a lot of public api's out there give you an API key, then you can wget <a href="https://publicapiurl" rel="nofollow">https://publicapiurl</a>. com/monster-status&nbsp; , and it returns dead or alive.. something like that.
1655243287
Gold
Forum Champion
I could be wrong, better wait for a confirmed answer from someone else. My thought is Roll20 has an API, and it is available for Subscribers in Games that they Created (own), so I don't know of it being a "public" API. Maybe it is and I just don't recognize the terminology.&nbsp;
1655245826
keithcurtis
Forum Champion
Marketplace Creator
API Scripter
Hi Anastasiia C.! It might make it easier to answer if you describe what you are trying to do. I.e. what task are you trying to accomplish? This might help avoid an XY problem .
Hey Guys,&nbsp; &nbsp;I want to make a script that notifies me when a monster has been killed.&nbsp; I have a linux server that does a wget on an api and returns the result.&nbsp; I can have the script run once an hour or something, and notify me when all of the monsters in a module have been killed. When I first read roll20 has an API that's what I thought I could do.&nbsp; Most companies like strava have an api that is free to use so people can make programs that use that data in their apps.
1655253568
keithcurtis
Forum Champion
Marketplace Creator
API Scripter
That is absolutely something that can be done with an API script, but access to the API is not free on Roll20. It runs in a server-side virtual machine and is a subscriber (Pro level) perk. You can find out basic API information staring&nbsp; here , and the sandbox model is explained in greater detail here .
Great thank you! I'll check out pro level. And try it out.
1655255871
GiGs
Pro
Sheet Author
API Scripter
I am thinking there might be a miscommunication here, and what you need can't be done Anastasiia. If you are trying to get information about a game, from outside the campaign, you really can't do that. (Proviso: you can use custom-built javascript or a browser extension to get some information, but not all information - but this is not a method native to Roll20: you have to know how to build such applications). The API Keith is referring to reuns inside the campaign, and has no ability to communicate with webpages outside of the campaign. It's not at all like the API that other webpages have: it's not used to connect outside programs. Now, you mention this: "a script that notifies me when a monster has been killed." ... " I can have the script run once an hour or something, and notify me when all of the monsters in a module have been killed." Roll20 is for tabletop rpgs not computer rpgs, and you wont have any game play without an actively present GM. Players don't log on and play adventures themselves, so there aren't going to be monsters dying when you (or the other GMs) aren't also playing. Can you be more specific about your needs, and we can tell you if it can be done?