Lookup API - Final Fantasy XI Database - FFXI

This API allows you to lookup objects in our database easily by Name or ID. Just follow the examples below to access the API. We have various parameters to let you pick different object types and even the returned encoding. A typical response will include the ID, Name, URL, and Icon URLs for that object.

API parameters available:

s - This param is used to set the search string for doing lookups by Name. This should always have a value if searching by Name. The results will mimic our general site search for each object however it will only return up to a maximum of 10 objects.

Sample URL:

http://ffxi.yg.com/api/lookup?s=Aquiline%20belt

i - This is the ID param and is used for looking up objects by ID. This should always have a value when doing lookups by ID.

Sample URL:

http://ffxi.yg.com/api/lookup?i=11733

t - Allows you to set the encoding type.

Encoding types:
- json (default)
- xml

Sample URL (json):

http://ffxi.yg.com/api/lookup?s=Aquiline%20belt&t=json

Sample Response:

{"objects":[{"id":11733,"name":"Aquiline belt", "url":"http:\/\/ffxi.yg.com\/item\/aquiline-belt?id=11733","icon" : {"small":"http:\/\/static.ygcdn.com\/ffxi\/img\/game\/small\/armor___13193___.png", "medium":"http:\/\/static.ygcdn.com\/ffxi\/img\/game\/medium\/armor___13193___.png"}}]}

Sample URL (xml):

http://ffxi.yg.com/api/lookup?s=Aquiline%20belt&t=xml

Sample Response:

	<?xml version="1.0" encoding="utf-8" ?>

	<yg_xml>

	  <object>

	    <id>11733</id>

	    <name>Aquiline belt</name>

	    <url>http://ffxi.yg.com/item/aquiline-belt?id=11733</url>

	    <icons>

	     <small>http://static.ygcdn.com/ffxi/img/game/small/armor___13193___.png</small>

	     <medium>http://static.ygcdn.com/ffxi/img/game/medium/armor___13193___.png</medium>

	    </icons>

	  </object>

	</yg_xml>

o - Allows you to set the object type.

Object types:
- item (default)

Sample URL (item):

http://ffxi.yg.com/api/lookup?s=Aquiline%20belt&o=item

Note: If parameter t or o is not set in the URL, the API will use their default values.

Multi-lingual Support:

Our API supports lookups for all of the languages we offer in our database simply by adding the character code before the /api/ section of the URL.

Character codes: de, fr, ja

Samples:
Deutsch - de

http://ffxi.yg.com/de/api/lookup?s=Aquiline-G%C3%BCrtel

Français - fr

http://ffxi.yg.com/fr/api/lookup?s=Ceinture%20aquiline

日本語 - ja

http://ffxi.yg.com/ja/api/lookup?s=アクィラインベルト

Note: Our API defaults to English lookups when no character code is set in the URL.

Sample URLs:

Item:

http://ffxi.yg.com/api/lookup?s=Bronze%20Sword&o=item&t=json

Item (Same as above but using the defaults):

http://ffxi.yg.com/api/lookup?s=Bronze%20Sword

Lookup API - Final Fantasy XI Database - FFXI - ffxi.yg.com

Final Fantasy XI Lookup API

API parameters available:

Multi-lingual Support:

Sample URLs: