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


Detailed module view [disabled]
Home

Mod Archive XML API Usage - Level 3 Features

These are freely accessible features, according to the usage terms outlined here


Browse Lists

Browse-by-Alphabet Lists


Returns alphabetically ordered lists of modules based on < query > being the first letter (in upper-case) of the file name.
  • Syntax:
    • request=view_by_list&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

This is faster and more efficient than using the Module File name search function below.

Browse-by-Rating (Comments) Lists


Returns ordered lists of modules based on <query> being the desired comment rating.
  • Syntax:
    • request=view_by_rating_comments&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

Browse-by-Rating (Reviews) Lists


Returns ordered lists of modules based on <query> being the desired review rating.
  • Syntax:
    • request=view_by_rating_reviews&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >



Artist Related Requests


Browse Modules by Associated Artist ID (number)


Requests a list of modules belonging to <query> where < query > is the Numeric Artist ID. Use ID 0 to find all modules not associated with any artists.
  • Syntax:
    • request=view_modules_by_artistid&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >
The query input requirement is for a number. Not text.

Browse Modules by Associated Guessed Artist Handle (text).


Requests a list of modules matching <query> where <query> is the potential alias of an artist.
  • Syntax:
    • request=view_modules_by_guessed_artist&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >




Module Selection


Request Specific Module (by Module ID number)


Requests data for a single module where < query > is the TMA Module ID Number.
  • Syntax:
    • request=view_by_moduleid&query=< query >
  • Additional Options:
    • opt-com=< 1|0 > (include member comments)
    • opt-rev=< 1|0 > (include reviews)

When requesting a module ID that no longer exists, an error is returned. In case the module has been merged into another module ID (because it was a duplicate), the XML response will also contain a field <redirect>42</redirect>, where 42 is the new module ID of the module.

Random Module Picker


Requests data for a randomly picked module.
  • Syntax:
    • request=random
  • Additional Options:
    • format=< mod/xm/s3m/it/etc... > - return only specified format.
    • genreid=< genre id number > - the genre list contains the numbers.
    • size=< range >
    • channels=< range >
    • download - directly redirects to the random module without obtaining any XML data.


Non-module Search Requests


Artist Roster Search


Requests a list of artists matching < query >. The < query > checks against both the Artist ID Number and the Artist's Alias.
  • Syntax:
    • request=search_artist&query=< query >
  • Additional Options:
    • page=< page number >
Currently a maximum of 50 results are returned. Therefore, Additional Options are currently not applicable but will be in future.

Genre List


Requests the list of Genres supported by The Mod Archive.
  • Syntax:
    • request=view_genres
  • Additional Options:
    • page=< page number >

Request Count (API Information)


Returns your current request count and how many requests you are permitted monthly.
  • Syntax:
    • request=view_requests

Requesting this particular item does not increase your request counter.


Specific Search Requests

Module File name


Returns search results for file names starting with < query >. The asterisk wildcard (*) can be used to find any sequence of characters, so if < query > should appear anywhere in the name, prepend it with an asterisk.
  • Syntax:
    • request=search&type=filename&query=<query>
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

Module Title


Returns search results for song titles starting with < query >. The asterisk wildcard (*) can be used to find any sequence of characters, so if < query > should appear anywhere in the name, prepend it with an asterisk.
  • Syntax:
    • request=search&type=songtitle&query=<query>
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

Module File name AND Title


Returns search results for < query > matching both the file name and the song title. You can also use the asterisk wildcard here.
  • Syntax:
    • request=search&type=filename_and_songtitle&query=<query>
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

Module File name OR Title


Returns search results for < query > matching either the file name, or song title. You can also use the asterisk wildcard here.
  • Syntax:
    • request=search&type=filename_or_songtitle&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >
    • channels=< range >

Modules of a Specific Genre


Requests a list of modules matching the Genre ID Number provided by < query >
  • Syntax:
    • request=search&type=genre&query=< query >
  • Additional Options:
    • format=< file format >
    • page=< page number >
    • size=< range >

The query input requirement is for a number. Not text.

MD5 Hash Search


Requests data for a single module where < query > is an MD5 hash.
  • Syntax:
    • request=search&type=hash&query=< query >