Records API Release Info & Documentation

Read official GWSCR.com announcements and learn how to use the forums.

Records API Release Info & Documentation

Postby Administrator » Sun Aug 25, 2013 2:13 pm

Hello everyone,

Today we've released the first version of our records API so that you can easily include our records data in your applications.

A few things to note:

  • The API is free to use for whatever purpose, however we ask that if you use it, you make it clear that it is a product of GWSCR.com. A link to us wouldn't hurt either :).
  • The API may be accessed as many times as you like, however it probably isn't necessary to access it more than once a week or once a day as players aren't currently posting records rapidly, meaning, for the most part you'll access the same data over and over.
  • With the pending release of the dungeon records table, the API location/the API syntax may change, and we will attempt to alert everyone when that happens.

The API is available in JSON format and is located at http://gwscr.com/api/records.json

Syntax explained:

The API returns an object with 2 properties and 8 objects.

  • Property 1 - "updated_date" : A string that describes the last time the records were updated (EST timezone).

  • Property 2 - "updated_by" : A string that describes which admin performed the update (you probably have no use for this string, but it is used by our admin panel).

  • The Objects : The 8 objects are for each of the 8 dungeons that we accept records for, identified by their shortcode.

    • Dungeon short codes can be determined here: http://gwscr.com/api/dungeon_names.json (but are also easily guessable :P)

    • Dungeon path names can be determined here: http://gwscr.com/api/dungeon_paths.json and are based on the explorable mode table on the official Guild Wars 2 Wiki.

    • Each of the 8 objects' properties are organized into 6 main categories with one property for each path of the dungeon, meaning there are 6 x 4 properties (Story, Path 1, Path 2, Path 3) for all dungeons except The Ruined City of Arah (6 x 5) which has an additional path (Path 4).

      The property syntax for each of the 8 objects is: <path_id>_<category>

      E.g.: 1_time, s_time, s_screens, 4_thread

      <path_id>s are as follow:

        s - Story
        1 - Path 1
        2 - Path 2
        3 - Path 3
        4 - Path 4 (only exists for The Ruined City of Arah)

      <category>s are as follow:

        thread - The URL for the thread on our forums where the record originated
        time - The time achieved for the record in minutes
        by - The name of the guild or player who achieved the record
        linkby - The URL for the guild or player who achieved the record (in the case of a player, the URL will be for his GWSCR.com forum profile page)
        screens - URLs for screenshots of the record, separated one per line
        videos - URLs for videos of the record, separated on per line

Additional notes:

  • If a path time category is empty or both it's screens and videos categories are empty, our table displays "No record submitted" for that path.

  • Each path may have any combination of categories filled out. E.g.: a path may show who achieved the record, but not a URL to them, or the path may have all categories filled out except the thread cateory, or the path may have both screens and videos as proof, etc.

Examples:

  • If you wanted to know the time of a record for the Ascalonian Catacombs, Path 1 (Hodgins), then you would access the "1_time" property of the object named "ac".

  • If you wanted to get a list of the videos of a record for The Ruined City of Arah, Path 4 (Seer), then you would access the "4_videos" property of the object named "arah", then you would separate the result by line.

Again, the records API is free to use for whatever purpose, however we ask that if you use it, you make it clear that it is a product of GWSCR.com.

We look forward to seeing your creations :). Enjoy!
Please direct questions, concerns, and proposals regarding gwscr.com to admin@gwscr.com.
User avatar
Administrator
Site Admin
 
Posts: 41
Joined: Tue Sep 20, 2011 10:59 pm

Re: Records API Release Info & Documentation

Postby Administrator » Thu Sep 05, 2013 8:19 pm

The records table has been updated to support time in minutes and seconds, subsequently affecting the records API.

The x_time (where x is a path id) property may now not only be whole numbers but sometimes things like 4:15 which translates to 4 minutes and 15 seconds.
Please direct questions, concerns, and proposals regarding gwscr.com to admin@gwscr.com.
User avatar
Administrator
Site Admin
 
Posts: 41
Joined: Tue Sep 20, 2011 10:59 pm

Re: Records API Release Info & Documentation

Postby Administrator » Thu Oct 10, 2013 7:16 pm

The records table has been updated to support the newly added Twilight Arbor Path 4 (Aetherpath).
Please direct questions, concerns, and proposals regarding gwscr.com to admin@gwscr.com.
User avatar
Administrator
Site Admin
 
Posts: 41
Joined: Tue Sep 20, 2011 10:59 pm

Re: Records API Release Info & Documentation

Postby Administrator » Mon Jan 27, 2014 2:41 am

Just a heads up to everyone using the API- the API is going to change drastically within the next few days because of new website requirements (see the new records rules/read about the records split).

Unfortunately the changes are so many that the current API will be discontinued when the new one goes live. I suggest you cache old data you have from us or disable your implementation until the new one goes up to avoid any errors.
Please direct questions, concerns, and proposals regarding gwscr.com to admin@gwscr.com.
User avatar
Administrator
Site Admin
 
Posts: 41
Joined: Tue Sep 20, 2011 10:59 pm


Return to Announcements & Forum Help

Who is online

Users browsing this forum: No registered users and 2 guests