[?] [X] [C] [TMALite]
Not logged in.


Detailed module view [disabled]
Home

The Mod Archive XML Tool. Document: 1.6

What is it?


An API to access the back end/database of The Mod Archive.

Instead of scraping the website HTML for data, the API provides a slimline low bandwidth equivalent that places far less overhead on the server.

To demonstrate how the API can be used:

  • The Mod Archive website itself is mostly powered via the API.
  • The LITE edition of the site is 100% API powered, and is hosted on a remote server.
  • Orgasmod shows favourite lists, 100% API powered.

The possibilities are endless, for instance; mobile devices can be programmed to play modules and download the meta data via the API.

API Key


The Mod Archive does not have unlimited resources, therefore it is necessary to ensure that there is some limit on the access to the API, this is done via an API key. API keys are granted upon successful application review, and also allow API-load to be tracked on a per-application basis.

Terms


Keys are granted on terms, these terms are agreed between you (the 3rd party), and The Mod Archive administrator on a per-case basis. The key is used to access the XML tool, without which access is not possible. It is very important that the key is kept as confidential as possible, it must not be willingly redistributed to other parties. It is understandable that apps can be reverse engineered or keys pulled from plain-text transmission over the Internet, however, negligent or deliberate sharing may lead to it being revoked.

The keys are merely a way to make it easier to stem an overload caused by a single application. A key can be withdrawn if misused. Keys expire based on the agreement under which the key was granted.

Please note that The Mod Archive API access is granted only after careful consideration by the administrator; The Mod Archive reserves to the right to deny cooperation for any or no reason at all, and also reserves the right to revoke access at any time for any or no reason at all.

Any transactions made in connection to the API and The Mod Archive hosting fund (donations) are non-refundable.

The Mod Archive reserves the right to change these terms without prior notice.

Access Levels

There are several levels of data available via the XML tool. The level depends upon the access-level you want.

Level 3


Features:
  • Free.
  • Search by:
    • File name,
    • Title
    • Module ID
    • Genre ID (based on the Genre Listing, also provided).
    • Artist ID (based on the Artist Roster, also provided).
    • MD5 Hash.
    • Guessed Artist.
  • Browse by:
    • Alphabet
    • Rating
    • Random Module picker.

The Next Level: 5


There is no advertising revenue to pay for hosting costs coming to The Mod Archive via this API. If you want to experiment with level 5 access then you can request so. Naturally, The Mod Archive has no obligation to fulfil such requests but will consider them on a case-by-case basis.

Features:
  • Search by:
    • File name,
    • Title
    • Module ID
    • Genre ID (based on the Genre Listing, also provided).
    • Artist ID (based on the Artist Roster, also provided).
    • MD5 Hash.
    • Guessed Artist.
  • Browse by:
    • Alphabet
    • Rating
    • Random Module picker.
  • Charts:
    • Featured
    • Top Members
    • Top Downloaded
    • Top Rated
    • Top Artists
    • Top Favourite Modules
  • View:
    • Artist Profiles
    • Member Profiles
    • Member Favourites
    • New Additions
  • Additional Searches:
    • Internal Module Sample Texts
    • Internal Module Comment Texts.


Limitations

Request Limitations:


The amount of traffic requests your application sends to the API is recorded. If your application exceeds the limit then the API returns an error.

What is the traffic limit?

Usually an upper limit of 100,000 requests per month.

Why is there a request limit at all?

It's there to protect our resources from abusive or resource hogging applications. If an application exceeds it's request limit then the usage needs to be looked in to.

Download limits


No matter whether using the API or the website, there is a daily download quota limit which is enforced globally to inconvenience and prevent mass-downloads via auto-download bots from overloading the server(s). You can obtain a maximum of 2000 downloads per day, per client IP, which is more than sufficient for personal entertainment. You are kindly asked to use the BitTorrent based alternative archive download if you wish to mass-download the archive.


Further Information

Applying for an API key


Register on the forums and post your case for an API key in this forum.

Usage

 
π