ZX-Art public API documentation

Common description

  1. API is publicly accessable via HTTP and JSON

  2. Information accuracy is not guaranteed, the information in databased is constantly being cleaned/rechecked/added.

  3. Information copying/backing up/usage for other databases is totally encouraged

  4. API format is subject to change without notification

Common parameters:

  • export - entity name quieried from API. All limiting and sorting parameters are being applied to this list.
    Possible values:

    • author

    • authorAlias

    • group

    • groupAlias

    • zxProdCategory

    • zxProd

    • zxRelease

    • zxPicture

    • zxMusic

  • language - language code for all translatable information.
    Possible values:

    • eng

    • rus

    • spa

  • start - number of the first required element from list

  • limit - quantity of elements in list

  • filter - can vary for different types of entities. Please contact if you require any specific filtration functionality

External database codenames:

  • 3a - ZXAAA

  • dzoo - DemoZoo

  • pouet - Pouet.net

  • sc - Spectrum Computing or ZXDB

  • wos - World Of Spectrum

  • vt - Virtual TR-DOS

  • zxd - Demotopia

Software category

All the software production are grouped into the software categories by genre or type.

Query example to get all the available software categories:
http://zxart.ee/api/export:zxProdCategory/filter:zxProdCategoryAll/

Fields:

  • id

  • title

  • categories - a list of subcategory IDs residing in this category.

Software production

This entity groups all the related releases into a single page.

First 10 productions:
http://zxart.ee/api/export:zxProd/limit:10/

First 10 productions for category with ID 92177:
http://zxart.ee/api/export:zxProd/start:0/limit:10/filter:zxProdCategory=92177/

Production with ID 92841:
http://zxart.ee/api/export:zxProd/filter:zxProdId=92841

Fields:

  • id

  • title

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • language - ISO 639-1 codes of supported languages

  • partyId - ID of demoparty/competition

  • partyPlace - place taken in party

  • compo - compo name

  • year - year of first publication

  • youtubeId - youtube video ID

  • description - description text

  • legalStatus - status of distribution

  • groupsIds - producing groups IDs

  • publishersIds - publisher groups IDs

  • releasesIds - IDs of releases

  • maps - list of game maps images URLs

  • authorsInfo - authorship information

    • authorId

    • roles

  • importIds - IDs used for this production in other databases.

Software production release

This is a version or release of a software production.

First 10 releases:
http://zxart.ee/api/action:filter/export:zxRelease/limit:10/

Releases of production with ID 92841:
http://zxart.ee/api/action:filter/export:zxRelease/filter:zxProdId=92841

Release with ID 92844:
http://zxart.ee/api/action:filter/export:zxRelease/filter:zxReleaseId=92844

Fields:

  • id

  • title

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • file - URL of file download

  • fileName - original filename

  • year - year of first publication. Zero if it’s the same as production’s one

  • publishersIds - publisher groups IDs

  • language - ISO 639-1 codes of supported languages. Empty if it’s the same as production’s one

  • description

  • authorsInfo - additional authors of this release

    • authorId

    • roles

  • hardwareRequired - list of minimum required hardware

  • hardwareOptional - list of additionally supported hardware

  • releaseType - type of release

    • unknown

    • original

    • rerelease

    • adaptation

    • localization

    • mod

    • crack

    • mia

    • corrupted

    • compilation

    • incomplete

    • demoversion

  • releaseFormat

    • dsk

    • tzx

    • tap

    • trd

    • scl

    • bin

    • sna

    • z80

    • fdi

    • udi

    • td0

    • rom

    • spg

  • version - version number of a release

  • inlays - URLs of cover inlay files

  • ads - URLs of advertisement files

  • instructions - URLs of manuals

  • importIds - IDs used for this release in other databases.

Author

Author is a person.

All authors:
http://zxart.ee/api/export:author/limit:10/filter:authorAll

Author with ID 2202:
http://zxart.ee/api/export:author/filter:authorId=2202

Fields:

  • id

  • title - author’s nickname

  • url - URL on ZX-Art

  • dateCreated

  • dateModified

  • realName

  • tunesQuantity

  • picturesQuantity

  • city - name of author’s city

  • country - name of author’s country

  • importIds - IDs used for this author in other databases

  • aliases - list of author’s aliases IDs

Author’s alias

Author’s alias is an alternative nickname of author.

All authors’ aliases:
http://zxart.ee/api/export:authorAlias/filter:authorAliasAll

Author’s alias with ID 86146:
http://zxart.ee/api/export:authorAlias/filter:authorAliasId=86146

Fields:

  • id

  • title - author aliases nickname

  • url - URL on ZX-Art

  • authorId - original author ID

  • importIds - IDs used for this author alias in other databases

Picture

A picture of author.

First 10 pictures:
http://zxart.ee/api/export:zxPicture/filter:zxPicture/limit:10

Picture with ID 2232:
http://zxart.ee/api/export:zxPicture/limit:10/filter:zxPictureId=2232

Fields:

  • id

  • title - picture name

  • url - URL on ZX-Art

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • partyId - ID of demoparty/competition

  • partyPlace - place taken in party

  • compo - compo name

  • authorIds - list of picture authors’ IDs

  • tags - tag names in selected language

  • type - image format type

  • rating - ZX-Art’s rating

  • views - quantity of views

  • year - year of publication

  • description

  • imageUrl - image URL in PC format

  • originalUrl - original binary file’s URL

Tune

Musical tune of author.

First 10 tunes:
http://zxart.ee/api/export:zxMusic/limit:10/

Tune with ID 19717:
http://zxart.ee/api/export:zxMusic/limit:10/filter:zxMusicId=19717

Fields:

  • id

  • title - tune name

  • url - URL on ZX-Art

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • partyId - ID of demoparty/competition

  • partyPlace - place taken in party

  • compo - compo name

  • authorIds - list of picture authors’ IDs

  • time - duration of tune

  • originalUrl - original binary file’s URL

Group

Group can be a demoscene group, publisher, company or any other group of authors.

First 10 groups:
http://zxart.ee/api/export:group/limit:10/

Group with ID 87126:

http://zxart.ee/api/export:group/filter:groupId=87126

Fields

  • id

  • title - group name

  • url - URL on ZX-Art

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • city - name of group’s city

  • country - name of group’s country

  • subGroupIds - group’s subgroups. Appropriate for associations.

  • importIds - IDs used for this group in other databases

  • aliases - list of group aliases’ IDs

Group’s alias

Group’s alias is an alternative title of group.

All groups’ aliases:
http://zxart.ee/api/export:groupAlias/filter:groupAliasAll

Group’s alias with ID 86117610946:
http://zxart.ee/api/export:authorAlias/filter:authorAliasId=176109

Fields:

  • id

  • title - author aliases nickname

  • url - URL on ZX-Art

  • dateCreated - creation date’s timestamp

  • dateModified - modification date’s timestamp

  • groupId - parent group ID

  • importIds - IDs used for this group’s alias in other databases