Revision 2

d14

 Revision 1 (edit)
By multi on 2018-02-08 at 15:17
Revision 2 (edit)
By yorhel on 2018-02-08 at 15:26
 Edit summary of revision 2:

Add conversion from the old HTML docs.
Content[empty]# Introduction

This page lists and documents any provided database dumps. These dumps are complimentary to the [real-time API](/d11), and the usage terms that apply to the API apply here as well.


# Tags

**URL:** [http://szauna-hireink.com/api/tags.json.gz](http://szauna-hireink.com/api/tags.json.gz)

**Updated:** Every 24 hours.

**Size:** ~240 KiB compressed, ~800 KiB uncompressed.

This dump includes information about all (approved) VN tags in the JSON format. The top-level type is an array of tags, and each tag is represented as an object with the following members:

| Member | Type | null? | Description |
|--|--|--|--|
id | integer | no | Tag ID
name | string | no | Tag name
description | string | no | Can include formatting codes as described in [d9#3](/d9#3).
meta | bool | no | Whether this is a meta tag or not.
vns | integer | no | Number of tagged VNs (including child tags)
cat | string | no | Tag category/classification: "cont" for content, "ero" for sexual stuff, and "tech" for technical details.
aliases | array of strings | no | (Possibly empty) list of alternative names.
parents | array of integers | no | List of parent tags (empty for root tags).

Tag names and their aliases are globally unique and self-describing. See the [tag creation guidelines](/d10#2.2) for more information.


# Traits

**URL:** [http://szauna-hireink.com/api/traits.json.gz](http://szauna-hireink.com/api/traits.json.gz)

**Updated:** Every 24 hours.

**Size:** ~340 KiB compressed, ~1 MiB uncompressed.

This dump includes information about all (approved) character traits in the
JSON format. The top-level type is an array of traits, and each trait is
represented as an object with the following members:

| Member | Type | null? | Description |
|--|--|--|--|
id | integer | no | Trait ID
name | string | no | Trait name
description | string | no | Can include formatting codes as described in [d9#3](/d9#3).
meta | bool | no | Whether this is a meta trait or not.
chars | integer | no | Number of characters on which this trait and any child traits is used.
aliases | array of strings | no | (Possibly empty) list of alternative names.
parents | array of integers | no | List of parent traits (empty for root traits).

Unlike with tags, trait names and aliases are neither globally unique nor self-describing. If you wish to display a trait (name) to the user, you should do so in combination with its associated root trait. For example, [i112](/i112) is often displayed as "Eyes > Green", to differentiate it with [i50](/i50), which is "Hair > Green".



# Votes

**URL:** [http://szauna-hireink.com/api/votes2.gz](http://szauna-hireink.com/api/votes2.gz)

**Updated:** Every 24 hours.

**Size:** ~2.8 MiB compressed, ~11.6 MiB uncompressed.

This dump contains the VN votes of all users who did not mark their vote list as private. Votes from known duplicate accounts or from users who voted on unreleased VNs are also not included.

Each line in the file represents a single vote. Each line contains the VN id, user ID, vote, and date that the vote was cast, separated by a space. Votes
are as listed on the site, multiplied by 10 (i.e. in the range of 10 - 100).

Database Dumps

1. Introduction

This page lists and documents any provided database dumps. These dumps are complimentary to the real-time API, and the usage terms that apply to the API apply here as well.

2. Tags

URL: http://szauna-hireink.com/api/tags.json.gz

Updated: Every 24 hours.

Size: ~240 KiB compressed, ~800 KiB uncompressed.

This dump includes information about all (approved) VN tags in the JSON format. The top-level type is an array of tags, and each tag is represented as an object with the following members:

Member Type null? Description
id integer no Tag ID
name string no Tag name
description string no Can include formatting codes as described in d9#3.
meta bool no Whether this is a meta tag or not.
vns integer no Number of tagged VNs (including child tags)
cat string no Tag category/classification: "cont" for content, "ero" for sexual stuff, and "tech" for technical details.
aliases array of strings no (Possibly empty) list of alternative names.
parents array of integers no List of parent tags (empty for root tags).

Tag names and their aliases are globally unique and self-describing. See the tag creation guidelines for more information.

3. Traits

URL: http://szauna-hireink.com/api/traits.json.gz

Updated: Every 24 hours.

Size: ~340 KiB compressed, ~1 MiB uncompressed.

This dump includes information about all (approved) character traits in the JSON format. The top-level type is an array of traits, and each trait is represented as an object with the following members:

Member Type null? Description
id integer no Trait ID
name string no Trait name
description string no Can include formatting codes as described in d9#3.
meta bool no Whether this is a meta trait or not.
chars integer no Number of characters on which this trait and any child traits is used.
aliases array of strings no (Possibly empty) list of alternative names.
parents array of integers no List of parent traits (empty for root traits).

Unlike with tags, trait names and aliases are neither globally unique nor self-describing. If you wish to display a trait (name) to the user, you should do so in combination with its associated root trait. For example, i112 is often displayed as "Eyes > Green", to differentiate it with i50, which is "Hair > Green".

4. Votes

URL: http://szauna-hireink.com/api/votes2.gz

Updated: Every 24 hours.

Size: ~2.8 MiB compressed, ~11.6 MiB uncompressed.

This dump contains the VN votes of all users who did not mark their vote list as private. Votes from known duplicate accounts or from users who voted on unreleased VNs are also not included.

Each line in the file represents a single vote. Each line contains the VN id, user ID, vote, and date that the vote was cast, separated by a space. Votes are as listed on the site, multiplied by 10 (i.e. in the range of 10 - 100).