Api

Introduction

This web API was built for the community at ServUO. It allows one to create web pages and other apps that include resources from the game Ultima Online very easily without having to host the thousands of images and resources one might have to otherwise. Especially if you are going to hue the image!

This API is free for anyone to use. However, be forewarned that while this API is hosted on in my opinion a service that is more than capable to handle it I cannot offer 100% availability. My hope is that it will be able to handle the wants of the community but if you create an application that is pulling thousands of requests to the API per day it might be better if you host the API yourself. It is all available at github.

Getting started

Getting started with this API is simple. You just have to grab the resource using one of the available endpoints which are all documents on this site. Depending on your programming language you would do this in different ways. For instance with PHP you might use curl or with C# you would use a http client. Stay tuned for examples.

Available EndPoints

Item Art

Available EndPoints : http://Services.ServUO.com/uoapi/item/
  • /Int:ID/
  • /Int:ID/Int:Hue/

Gump Art

Available EndPoints : =http://Services.ServUO.com/uoapi/gump/
  • /Int:ID/
  • /Int:ID/Int:Hue/

Multi Art

Available EndPoints : http://Services.ServUO.com/uoapi/multi/
  • /Int:ID/
  • /Int:ID/Int:Hue/

Animations

Available EndPoints : http://Services.ServUO.com/uoapi/anim/
  • /Int:ID/
  • /Int:ID/Int:Hue/
  • /Int:ID/Int:Action/Int:Direction/
  • /Int:ID/Int:Action/Int:Direction/Bool:FirstFrameOnly/
  • /Int:ID/Int:Action/Int:Direction/Bool:FirstFrameOnly/Int:Hue/
  • /Int:ID/Int:Action/Int:Direction/Bool:FirstFrameOnly/Int:Hue/Int:RepeatCount/

Note that for RepeatCount 0 is forever and -1 is just once.

Example:
<img src="http://Services.ServUO.com/uoapi/anim/987/35"/>
Result:
<img src="http://Services.ServUO.com/uoapi/anim/1/3/2/false/-1" />
Result:

Sounds

Available EndPoints : http://Services.ServUO.com/uoapi/sound/
  • /ID/
Example:
<audio controls>
<source src="http://suoservices.azurewebsites.net/uoapi/sound/67" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
Result: