Mod Archive XML API Usage - Level 5 Features
These are in addition to Level 3 features.
Additional Searches
Additions in the last 30 days
Returns a list of modules added to the archive in the last 30 days.
- Syntax:
- request=search&type=new_additions&query=DUMMY
- request=search&type=new_additions&query=DUMMY
- Additional Options:
Search Module Sample Texts
Returns search results for < query > matching text within a module's internal sample texts.
- Syntax:
- request=search&type=module_instruments&query=< query >
- request=search&type=module_instruments&query=< query >
- Additional Options:
Search Module Comment Texts
Returns search results for < query > matching text within a module's internal comment texts.
Charts
Featured Modules
- Syntax:
- request=chart&query=featured
- request=chart&query=featured
Top Downloads
Requests list of modules that have the highest download totals.
- Syntax:
- request=chart&query=tophits
- request=chart&query=tophits
Top Rating
Requests list of modules that have the highest member ratings.
- Syntax:
- request=chart&query=topscore
- request=chart&query=topscore
Top Artists
Requests list of artists that have the highest member ratings.
- Syntax:
- request=chart&query=topartists
- request=chart&query=topartists
Top Members
Requests list of members that have earned the most points.
- Syntax:
- request=chart&query=topmembers
- request=chart&query=topmembers
Favourites
View Member Favourites
Requests list of a member's favourites.
- Syntax:
- request=view_member_favourites&query=< member_id >
- request=view_member_favourites&query=< member_id >
- Additional Options:
- order=< 1|2|3|4|5|6 > - order (see Orders below)
- page=< page number >
- opt-username=< 1|0 > - interpret < query > as username rather than member_id
- opt-all=< 1|0 > - ignore userid and return all favourites. User details associated with returned favourites are superfluous as they are random if the module has been picked by more than one member as a favourite. Note: query=< query > still has to be set to a non-null value, although it is ignored in this case.
- limit=< number > - return x results per page. minimum is 40.
- order=< 1|2|3|4|5|6 > - order (see Orders below)
- Orders
- 1: Date New->Old
- 2: Date Old->New
- 3: Filename A->Z
- 4: Filename Z->A
- 5: Title A->Z
- 6: Title Z->A
- 1: Date New->Old
View List of members with favourites
Requests list of members with populated favourite lists .
- Syntax:
- request=view_favourite_lists
- request=view_favourite_lists
- Additional Options:
- order=< 1|2|3 > (see Orders below)
- page=< page number >
- order=< 1|2|3 > (see Orders below)
- Orders
- 1: Last Login date
- 2: By Profile Name
- 3: Highest Favourite Count
- 1: Last Login date