ProjectPokemon Wiki - User contributions [en]

GTS protocol

2011-06-05T03:59:10Z

Xfr:

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

In generation 5, the server must append to all its responses a footer generated by <code>sha1("HZEdGCzcGGLvguqUEKQN"+urlsafe_base64(response)+"HZEdGCzcGGLvguqUEKQN")</code>.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001. Note that in generation 5, some tests are performed on a pokémon before it is deposited. If the pokémon is rejected at this stage (a problem was detected or one of the OT name or nickname is inappropriate) it is NOT sent to the GTS and error 13267 is displayed.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0C-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100
| Requested Max Level
|- style="background: #eee;" align="center"
| 0x101
| Unknown / Always 0
|- style="background: #ddd;" align="center"
| 0x102
| Trainer gender
|- style="background: #ddd;" align="center"
| 0x103
| Trainer nature
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| [[#Trainer Class|Trainer class/sprite]]
|- style="background: #eee;" align="center"
| 0x12F
| Always 0
|- style="background: #ddd;" align="center"
| 0x130
| Game version
|- style="background: #eee;" align="center"
| 0x131
| Region/language
|- style="background: #ddd;" align="center"
| 0x132
| '''Unknown''' (0 to 8)
|- style="background: #eee;" align="center"
| 0x133
| Unlocked floors in Unity Tower
|- style="background: #ddd;" align="center"
| 0x134-0x137
| Unused
|- style="background: #eee;" align="center"
| 0x138-0x1B7
| Signature of pokémon struct
|- style="background: #ddd;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

In generation 4, the sent data is 296 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| PID
|- style="background: #ddd;" align="center"
| 0x04-0xEF
| Encrypted [[Pokemon NDS Structure|party pokemon data structure]]
|- style="background: #eee;" align="center"
| 0xF0-0xF1
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xF2
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xF3
| Level
|- style="background: #ddd;" align="center"
| 0xF4-Fx05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xF6
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xF7
| Requested Min Level
|- style="background: #eee;" align="center"
| 0xF8
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| Always 0
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0xF9-0x109
| Zero / Timestamps and PID placeholders
|- style="background: #eee;" align="center"
| 0x110-0x11F
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x120-0x121
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x122
| Country
|- style="background: #ddd;" align="center"
| 0x123
| City
|- style="background: #eee;" align="center"
| 0x124
| [[#Trainer Class|Trainer's Sprite]]
|- style="background: #ddd;" align="center"
| 0x125
| Is Exchanged Flag
|- style="background: #eee;" align="center"
| 0x126
| [[#Game Version|Game Version]]
|- style="background: #ddd;" align="center"
| 0x127
| [[Pokemon NDS Structure#Original Language|Language]]
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| [[#Trainer Class|Trainer's Sprite]]
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown''
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Trainer Class ===
(for generation 5)
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Class
|- style="background: #eee;" align="center"
| 0x00
| Youngster
|- style="background: #ddd;" align="center"
| 0x01
| Ace Trainer
|- style="background: #eee;" align="center"
| 0x02
| Pokémon Ranger
|- style="background: #ddd;" align="center"
| 0x03
| Pokémon Breeder
|- style="background: #eee;" align="center"
| 0x04
| Researcher
|- style="background: #ddd;" align="center"
| 0x05
| Hiker
|- style="background: #eee;" align="center"
| 0x06
| Skinhead
|- style="background: #ddd;" align="center"
| 0x07
| Day-Care student
|- style="background: #eee;" align="center"
| 0x08
| Lass
|- style="background: #ddd;" align="center"
| 0x09
| Ace Trainer (female)
|- style="background: #eee;" align="center"
| 0x0a
| Pokémon Ranger (female)
|- style="background: #ddd;" align="center"
| 0x0b
| Pokémon Breeder (female)
|- style="background: #eee;" align="center"
| 0x0c
| Researcher (female)
|- style="background: #ddd;" align="center"
| 0x0d
| Parasol Lady
|- style="background: #eee;" align="center"
| 0x0e
| Nurse
|- style="background: #ddd;" align="center"
| 0x0f
| Day-Care student (female)
|}

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

GTS protocol

2011-04-19T18:24:18Z

Xfr:

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

In generation 5, the server must append to all its responses a footer generated by <code>sha1("HZEdGCzcGGLvguqUEKQN"+urlsafe_base64(response)+"HZEdGCzcGGLvguqUEKQN")</code>.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0C-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100
| Requested Max Level
|- style="background: #eee;" align="center"
| 0x101
| Unknown / Always 0
|- style="background: #ddd;" align="center"
| 0x102
| Trainer gender
|- style="background: #ddd;" align="center"
| 0x103
| Trainer nature
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| [[#Trainer Class|Trainer class/sprite]]
|- style="background: #ddd;" align="center"
| 0x12F
| Always 0
|- style="background: #eee;" align="center"
| 0x130
| Game version
|- style="background: #ddd;" align="center"
| 0x131
| Region/language
|- style="background: #eee;" align="center"
| 0x132-0x137
| Always 0
|- style="background: #ddd;" align="center"
| 0x138-0x1B7
| Mystery data (encrypted?)
|- style="background: #eee;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| [[#Trainer Class|Trainer's Sprite]]
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown''
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Trainer Class ===
(for generation 5)
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Class
|- style="background: #eee;" align="center"
| 0x00
| Youngster
|- style="background: #ddd;" align="center"
| 0x01
| Ace Trainer
|- style="background: #eee;" align="center"
| 0x02
| Pokémon Ranger
|- style="background: #ddd;" align="center"
| 0x03
| Pokémon Breeder
|- style="background: #eee;" align="center"
| 0x04
| Researcher
|- style="background: #ddd;" align="center"
| 0x05
| Hiker
|- style="background: #eee;" align="center"
| 0x06
| Skinhead
|- style="background: #ddd;" align="center"
| 0x07
| Day-Care student
|- style="background: #eee;" align="center"
| 0x08
| Lass
|- style="background: #ddd;" align="center"
| 0x09
| Ace Trainer (female)
|- style="background: #eee;" align="center"
| 0x0a
| Pokémon Ranger (female)
|- style="background: #ddd;" align="center"
| 0x0b
| Pokémon Breeder (female)
|- style="background: #eee;" align="center"
| 0x0c
| Researcher (female)
|- style="background: #ddd;" align="center"
| 0x0d
| Parasol Lady
|- style="background: #eee;" align="center"
| 0x0e
| Nurse
|- style="background: #ddd;" align="center"
| 0x0f
| Day-Care student (female)
|}

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

GTS protocol

2011-04-19T17:00:08Z

Xfr:

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

In generation 5, the server must append to all its responses a footer generated by <code>sha1("HZEdGCzcGGLvguqUEKQN"+urlsafe_base64(response)+"HZEdGCzcGGLvguqUEKQN")</code>.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0C-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100
| Requested Max Level
|- style="background: #eee;" align="center"
| 0x101
| Unknown / Always 0
|- style="background: #ddd;" align="center"
| 0x102
| Trainer gender
|- style="background: #ddd;" align="center"
| 0x103
| Trainer nature
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| [[#Trainer Class|Trainer class/sprite]]
|- style="background: #ddd;" align="center"
| 0x12F
| Always 0
|- style="background: #eee;" align="center"
| 0x130
| Game version
|- style="background: #ddd;" align="center"
| 0x131
| Region/language
|- style="background: #eee;" align="center"
| 0x132-0x137
| Always 0
|- style="background: #ddd;" align="center"
| 0x138-0x1B7
| Mystery data (encrypted?)
|- style="background: #eee;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| [[#Trainer Class|Trainer's Sprite]]
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown''
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Trainer Class ===
(for generation 5)
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Class
|- style="background: #eee;" align="center"
| 0x00
| Youngster / Lass
|- style="background: #ddd;" align="center"
| 0x01
| Ace Trainer
|- style="background: #eee;" align="center"
| 0x02
| Pokémon Ranger
|- style="background: #ddd;" align="center"
| 0x03
| Pokémon Breeder
|- style="background: #eee;" align="center"
| 0x04
| Researcher
|- style="background: #ddd;" align="center"
| 0x05
| Hiker / Parasol Lady
|- style="background: #eee;" align="center"
| 0x06
| Skinhead / Nurse
|- style="background: #ddd;" align="center"
| 0x07
| Day-Care student
|}

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

GTS protocol

2011-04-19T14:46:14Z

Xfr:

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

In generation 5, the server must append to all its responses a footer generated by <code>sha1("HZEdGCzcGGLvguqUEKQN"+urlsafe_base64(response)+"HZEdGCzcGGLvguqUEKQN")</code>.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0C-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100-0x102
| Always 0
|- style="background: #ddd;" align="center"
| 0x103
| Unknown / seems to be 0x02?
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| [[#Trainer Class|Trainer class/sprite]]
|- style="background: #ddd;" align="center"
| 0x12F
| Always 0
|- style="background: #eee;" align="center"
| 0x130
| Game version
|- style="background: #ddd;" align="center"
| 0x131
| Region/language
|- style="background: #eee;" align="center"
| 0x132-0x137
| Always 0
|- style="background: #ddd;" align="center"
| 0x138-0x1B7
| Mystery data (encrypted?)
|- style="background: #eee;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| [[#Trainer Class|Trainer's Sprite]]
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown''
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Trainer Class ===
(for generation 5)
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Class
|- style="background: #eee;" align="center"
| 0x00
| Youngster / Lass
|- style="background: #ddd;" align="center"
| 0x01
| Ace Trainer
|- style="background: #eee;" align="center"
| 0x02
| Pokémon Ranger
|- style="background: #ddd;" align="center"
| 0x03
| Pokémon Breeder
|- style="background: #eee;" align="center"
| 0x04
| Researcher
|- style="background: #ddd;" align="center"
| 0x05
| Hiker / Parasol Lady
|- style="background: #eee;" align="center"
| 0x06
| Skinhead / Nurse
|- style="background: #ddd;" align="center"
| 0x07
| Day-Care student
|}

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

Pokemon Black/White Save Structure

2011-04-13T00:53:21Z

Xfr: Added information on encoding of nickname and OT name

Pokémon in the games Pokémon [[Pokémon Black|Black]] and [[Pokemon White|White]] are stored in a 136 byte or 220 byte structures. All unencrypted values are stored in [[little-endian|little-endian]] format. The game encrypts the data when it is stored in the [[Pokémon NDS Save File Structure|save file]]. Party Pokémon have additional values to hold current battle stats and conditions. The information below describes the Pokémon data format.

== Checksum ==

<Placeholder>

== Block Shuffling ==

<Placeholder>

== Encryption ==

<Placeholder>

== Unencrypted bytes ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x03
| [[Personality value]] (Also known as the [[PID]])
|- style="background: #ddd;" align="center"
| 0x04-0x05
| ''Unused''
|- style="background: #eee;" align="center"
| 0x06-0x07
| Checksum
|}

== Encrypted bytes ==
=== Block A ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x08-0x09
| [[Nationaldex|National Pokédex ID]]
|- style="background: #ddd;" align="center"
| 0x0A-0x0B
| [[item index|Held Item]]
|- style="background: #eee;" align="center"
| 0x0C-0x0D
| [[Original Trainer|OT ID]]
|- style="background: #ddd;" align="center"
| 0x0E-0x0F
| [[Original Trainer|OT Secret ID]]
|- style="background: #eee;" align="center"
| 0x10-0x13
| [[Experience Points|Experience points]]
|- style="background: #ddd;" align="center"
| 0x14
| Friendship (Steps to Hatch if an egg)
|- style="background: #eee;" align="center"
| 0x15
| [[Ability]]
|- style="background: #ddd;" align="center"
| 0x16
| [[#Markings|Markings]]
|- style="background: #eee;" align="center"
| 0x17
| [[#Original Language|Original Language]]

|- style="background: #ddd;" align="center"
| 0x18
| [[Effort Values#Hit Points|HP Effort Value]]
|- style="background: #eee;" align="center"
| 0x19
| [[Effort Values#Attack Points|Attack Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1A
| [[Effort Values#Defense Points|Defense Effort Value]]
|- style="background: #eee;" align="center"
| 0x1B
| [[Effort Values#Speed Points|Speed Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1C
| [[Effort Values#Special Attack Points|SP Attack Effort Value]]
|- style="background: #eee;" align="center"
| 0x1D
| [[Effort Values#Special Defense Points|SP Defense Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1E
| [[Contest Stats#Cool|Cool Contest Value]]
|- style="background: #eee;" align="center"
| 0x1F
| [[Contest Stats#Beauty|Beauty Contest Value]]

|- style="background: #ddd;" align="center"
| 0x20
| [[Contest Stats#Cute|Cute Contest Value]]
|- style="background: #eee;" align="center"
| 0x21
| [[Contest Stats#Smart|Smart Contest Value]]

|- style="background: #ddd;" align="center"
| 0x22
| [[Contest Stats#Tough|Tough Contest Value]]
|- style="background: #eee;" align="center"
| 0x23
| [[Contest Stats#Sheen|Sheen Contest Value]]

|- style="background: #ddd;" align="center"
| 0x24-0x25
| [[#Sinnoh Ribbon Set 1|Sinnoh Ribbon Set 1]]
|- style="background: #eee;" align="center"
| 0x26-0x27
| [[#Sinnoh Ribbon Set 2|Sinnoh Ribbon Set 2]]
|}

=== Block B ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x28-0x29
| [[Pokemon Moves|Move 1 ID]]
|- style="background: #ddd;" align="center"
| 0x2A-0x2B
| [[Pokemon Moves|Move 2 ID]]
|- style="background: #eee;" align="center"
| 0x2C-0x2D
| [[Pokemon Moves|Move 3 ID]]
|- style="background: #ddd;" align="center"
| 0x2E-0x2F
| [[Pokemon Moves|Move 4 ID]]
|- style="background: #eee;" align="center"
| 0x30
| [[Pokemon Moves#Power Points|Move 1 Current PP]]
|- style="background: #ddd;" align="center"
| 0x31
| [[Pokemon Moves#Power Points|Move 2 Current PP]]
|- style="background: #eee;" align="center"
| 0x32
| [[Pokemon Moves#Power Points|Move 3 Current PP]]
|- style="background: #ddd;" align="center"
| 0x33
| [[Pokemon Moves#Power Points|Move 4 Current PP]]
|- style="background: #eee;" align="center"
| 0x34-0x37
| [[Pokemon Moves#Power Points|Move PP Ups]]
|- style="background: #ddd;" align="center"
| 0x38-0x3B
| Bits 0-29 - [[Individual Values]] 
[[Individual Values#Hit Points|HP]] ( [0-31] << 0 ) 
[[Individual Values#Attack Points|Attack]] ( [0-31] << 5 ) 
[[Individual Values#Defense Points|Defense]] ( [0-31] << 10 ) 
[[Individual Values#Speed Points|Speed]] ( [0-31] << 15 ) 
[[Individual Values#Special Attack Points|SP Attack]] ( [0-31] << 20 ) 
[[Individual Values#Special Defense Points|SP Defense]] ( [0-31] << 25 ) 
Bit 30 - IsEgg Flag Bit 31 - IsNicknamed Flag
|- style="background: #eee;" align="center"
| 0x3C-0x3D
| [[#Hoenn Ribbon Set 1|Hoenn Ribbon Set 1]]
|- style="background: #ddd;" align="center"
| 0x3E-0x3F
| [[#Hoenn Ribbon Set 2|Hoenn Ribbon Set 2]]
|- style="background: #eee;" align="center"
| 0x40
| Bit 0 - Fateful Encounter Flag Bit 1 - Female Bit 2 - Genderless Bit 3-7 - [[#Alternate Forms|Alternate Forms]]
|- style="background: #ddd;" align="center"
| 0x41
| Nature
|- style="background: #eee;" align="center"
| 0x42
| HasDreamWorldAbility Flag
|- style="background: #ddd;" align="center"
| 0x43
| ''Unused''
|- style="background: #eee;" align="center"
| 0x44-0x45
| ''Deleted / Unused''
|- style="background: #ddd;" align="center"
| 0x46-0x47
| ''Deleted / Unused''
|}

=== Block C ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x48-0x5D
| [[#Nickname and OT Name|Nickname]]
|- style="background: #ddd;" align="center"
| 0x5E
| ''Unused''
|- style="background: #eee;" align="center"
| 0x5F
| [[Pokemon Hometown|Hometown]]
|- style="background: #ddd;" align="center"
| 0x60-0x61
| [[#Sinnoh Ribbon Set 3|Sinnoh Ribbon Set 3]]
|- style="background: #eee;" align="center"
| 0x62-0x63
| [[#Sinnoh Ribbon Set 4|Sinnoh Ribbon Set 4]]
|- style="background: #ddd;" align="center"
| 0x64-0x67
| ''Unused''
|}

=== Block D ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x68-0x77
| [[#Nickname and OT Name|OT Name]]
|- style="background: #ddd;" align="center"
| 0x78-0x7A
| Date Egg Received
|- style="background: #eee;" align="center"
| 0x7B-0x7D
| Date Met
|- style="background: #ddd;" align="center"
| 0x7E-0x7F
| Egg [[Pokemon NDS Locations|Location]] (Diamond/Pearl)
|- style="background: #eee;" align="center"
| 0x80-0x81
| Met At [[Pokemon NDS Locations|Location]] (Diamond/Pearl)
|- style="background: #ddd;" align="center"
| 0x82
| [[Pokerus|Pokérus]]
|- style="background: #eee;" align="center"
| 0x83
| [http://projectpokemon.org/wiki/List_of_Diamond,_Pearl,_Platinum,_HeartGold_and_SoulSilver_Items_by_Index_Number#Balls Poké Ball]
|- style="background: #ddd;" align="center"
| 0x84
| Bit 0-6 - Met At Level Bit 7 - Female OT Gender
|- style="background: #eee;" align="center"
| 0x85
| [[#Encounter Types|Encounter Type]]
|- style="background: #ddd;" align="center"
| 0x86
| ''Unused''
|- style="background: #eee;" align="center"
| 0x87
| ''Unused''

|}

== Battle Stats ==

The battle stats are encrypted in the same manner, however the seed is not the checksum, it is the PID.

=== Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x88
| Bits 0-2 - Asleep (0-7 rounds) Bit 3 - Poisoned Bit 4 - Burned Bit 5 - Frozen Bit 6 - Paralyzed Bit 7 - Toxic
|- style="background: #ddd;" align="center"
| 0x89
| ''Unknown'' - Flags - Max Value 0xF0
|- style="background: #eee;" align="center"
| 0x8A-0x8B
| ''Unknown''
|- style="background: #ddd;" align="center"
| 0x8C
| Level
|- style="background: #eee;" align="center"
| 0x8D
| Capsule Index (Seals)
|- style="background: #ddd;" align="center"
| 0x8E-0x8F
| Current HP
|- style="background: #eee;" align="center"
| 0x90-0x91
| Max HP
|- style="background: #ddd;" align="center"
| 0x92-0x93
| Attack
|- style="background: #eee;" align="center"
| 0x94-0x95
| Defense
|- style="background: #ddd;" align="center"
| 0x96-0x97
| Speed
|- style="background: #eee;" align="center"
| 0x98-0x99
| Special Attack
|- style="background: #ddd;" align="center"
| 0x9A-0x9B
| Special Defense
|- style="background: #eee;" align="center"
| 0x9C-0xD3
| ''Unknown'' - Contains Trash Data
|- style="background: #ddd;" align="center"
| 0xD4-0xDB
| ''Unknown'' - all 0s?

|}

== Original Language ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Value
! Language
|- style="background: #eee;" align="center"
| 0x1
| 日本語 (Japan)
|- style="background: #ddd;" align="center"
| 0x2
| English (US/UK/AU)
|- style="background: #eee;" align="center"
| 0x3
| Français (France/Québec)
|- style="background: #ddd;" align="center"
| 0x4
| Italiano (Italy)
|- style="background: #eee;" align="center"
| 0x5
| Deutsch (Germany)
|- style="background: #ddd;" align="center"
| 0x7
| Español (Spain/Latin Americas)
|- style="background: #eee;" align="center"
| 0x8
| 한국어 (South Korea)
|}

== Markings ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Marking
|- style="background: #eee;" align="center"
| 0x01
| Circle
|- style="background: #ddd;" align="center"
| 0x02
| Triangle
|- style="background: #eee;" align="center"
| 0x04
| Square
|- style="background: #ddd;" align="center"
| 0x08
| Heart
|- style="background: #eee;" align="center"
| 0x10
| Star
|- style="background: #ddd;" align="center"
| 0x20
| Diamond
|}

== Alternate Forms ==
Alternate forms are stored at offset 0x40 of the Pokemon structure. Each form follows the pattern of ''index << 3'' where index starts at zero for the main form.

=== Unown's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
! Bit
! Form
! Bit
! Form
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| A
| 0x38
| H
| 0x70
| O
| 0xA8
| V
|- style="background: #ddd;" align="center"
| 0x08
| B
| 0x40
| I
| 0x78
| P
| 0xB0
| W
|- style="background: #eee;" align="center"
| 0x10
| C
| 0x48
| J
| 0x80
| Q
| 0xB8
| X
|- style="background: #ddd;" align="center"
| 0x18
| D
| 0x50
| K
| 0x88
| R
| 0xC0
| Y
|- style="background: #eee;" align="center"
| 0x20
| E
| 0x58
| L
| 0x90
| S
| 0xC8
| Z
|- style="background: #ddd;" align="center"
| 0x28
| F
| 0x60
| M
| 0x98
| T
| 0xD0
| !
|- style="background: #eee;" align="center"
| 0x30
| G
| 0x68
| N
| 0xA0
| U
| 0xD8
| ?
|}

=== Deoxy's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
|- style="background: #ddd;" align="center"
| 0x08
| Attack
|- style="background: #eee;" align="center"
| 0x10
| Defense
|- style="background: #ddd;" align="center"
| 0x18
| Speed
|}

=== Burmy's & Wormadam's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Plant
|- style="background: #ddd;" align="center"
| 0x08
| Sandy
|- style="background: #eee;" align="center"
| 0x10
| Trash
|}

=== Shellos' & Gastrodon's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| West
|- style="background: #ddd;" align="center"
| 0x08
| East
|}

=== Rotom's Forms ===
Rotom's alternate forms will only be displayed in Pokemon Platinum. Rotom may be traded between Diamond, Pearl, and Platinum without losing the alternate form.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
|- style="background: #ddd;" align="center"
| 0x08
| Heat
|- style="background: #eee;" align="center"
| 0x10
| Wash
|- style="background: #ddd;" align="center"
| 0x18
| Frost
|- style="background: #eee;" align="center"
| 0x20
| Fan
|- style="background: #ddd;" align="center"
| 0x28
| Cut
|}

=== Giratina's Forms ===
Giratina's Origin form will only be displayed in Pokemon Platinum.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Altered
|- style="background: #ddd;" align="center"
| 0x08
| Origin
|}

=== Shaymin's Forms ===
Shaymin's Sky form will only be displayed in Pokemon Platinum.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Land
|- style="background: #ddd;" align="center"
| 0x08
| Sky
|}

=== Arceus' Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
! Bit
! Form
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
| 0x30
| Insect
| 0x60
| Zap
|- style="background: #ddd;" align="center"
| 0x08
| Fist
| 0x38
| Spooky
| 0x68
| Mind
|- style="background: #eee;" align="center"
| 0x10
| Sky
| 0x40
| Iron
| 0x70
| Icicle
|- style="background: #ddd;" align="center"
| 0x18
| Toxic
| 0x48
| Flame
| 0x78
| Draco
|- style="background: #eee;" align="center"
| 0x20
| Earth
| 0x50
| Splash
| 0x80
| Dread
|- style="background: #ddd;" align="center"
| 0x28
| Stone
| 0x58
| Meadow
| 0x4C
| Curse
|}
== Nickname and OT Name ==

Since generation 5, the nickname and OT name are encoded with Unicode instead of a
game-specific character map. However, there are some exceptions, which are listed
below. Note that unlike generation 4, the last two bytes are always 0xFFFF, even
if there already was a terminator before. There are no trash bytes in generation 5
pokemon but the Poké Transfer will keep existing trash bytes (except the last two)
even if the pokemon evolves in generation 5.

=== Characters that can be replaced in Unicode ===
In the game, those are half-width versions of existing Unicode characters used
in non-japanese versions with long name support.

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Original character
! Unicode index
! Replace with
! Unicode index
|- style="background: #eee;" align="center"
| ⑽
| 0x247d
| ☂
| 0x2602
|- style="background: #ddd;" align="center"
| ⑻
| 0x247b
| ☁
| 0x2601
|- style="background: #eee;" align="center"
| ⑺
| 0x247a
| ☀
| 0x2600
|- style="background: #ddd;" align="center"
| ⑹
| 0x2479
| ♪
| 0x266a
|- style="background: #eee;" align="center"
| ⑸
| 0x2478
| ◇
| 0x25c7
|- style="background: #ddd;" align="center"
| ⑷
| 0x2477
| △
| 0x25b3
|- style="background: #eee;" align="center"
| ⑶
| 0x2476
| □
| 0x25a1
|- style="background: #ddd;" align="center"
| ⑵
| 0x2475
| ○
| 0x25cb
|- style="background: #eee;" align="center"
| ⑴
| 0x2474
| ◎
| 0x25ce
|- style="background: #ddd;" align="center"
| ⑳
| 0x2473
| ★
| 0x2605
|- style="background: #eee;" align="center"
| ⑲
| 0x2472
| ♦
| 0x2666
|- style="background: #ddd;" align="center"
| ⑱
| 0x2471
| ♥
| 0x2665
|- style="background: #eee;" align="center"
| ⑰
| 0x2470
| ♣
| 0x2663
|- style="background: #ddd;" align="center"
| ⑯
| 0x246f
| ♠
| 0x2660
|- style="background: #eee;" align="center"
| ⑮
| 0x246e
| ♀
| 0x2640
|- style="background: #ddd;" align="center"
| ⑭
| 0x246d
| ♂
| 0x2642
|- style="background: #eee;" align="center"
| ⑬
| 0x246c
| …
| 0x2026
|- style="background: #ddd;" align="center"
| ⑨
| 0x2468
| ÷
| 0xf7
|- style="background: #eee;" align="center"
| ⑧
| 0x2467
| ×
| 0xd7
|}

=== Pokémon exclusive characters ===
Some game-exclusive characters do not exist in Unicode and should be replaced with bitmaps.

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Original character
! Unicode index
! Pokémon exclusive
|- style="background: #eee;" align="center"
| $
| 0x24
| [[File:gen5_unicode_36.png]]
|- style="background: #eee;" align="center"
| ⇒
| 0x21d2
| [[File:gen5_unicode_8658.png]]
|- style="background: #eee;" align="center"
| ⇔
| 0x21d4
| [[File:gen5_unicode_8660.png]]
|- style="background: #eee;" align="center"
| ∀
| 0x2200
| [[File:gen5_unicode_8704.png]]
|- style="background: #eee;" align="center"
| ∃
| 0x2203
| [[File:gen5_unicode_8707.png]]
|- style="background: #eee;" align="center"
| ∧
| 0x2227
| [[File:gen5_unicode_8743.png]]
|- style="background: #eee;" align="center"
| ∨
| 0x2228
| [[File:gen5_unicode_8744.png]]
|- style="background: #eee;" align="center"
| ①
| 0x2460
| [[File:gen5_unicode_9312.png]]
|- style="background: #eee;" align="center"
| ②
| 0x2461
| [[File:gen5_unicode_8744.png]]
|- style="background: #eee;" align="center"
| ③
| 0x2462
| [[File:9314.png]]
|- style="background: #eee;" align="center"
| ④
| 0x2463
| [[File:gen5_unicode_8658.png]]
|- style="background: #eee;" align="center"
| ⑤
| 0x2464
| [[File:gen5_unicode_8660.png]]
|- style="background: #eee;" align="center"
| ⑥
| 0x2465
| [[File:gen5_unicode_8704.png]]
|- style="background: #eee;" align="center"
| ⑦
| 0x2466
| [[File:gen5_unicode_8707.png]]
|- style="background: #eee;" align="center"
| ⑩
| 0x2469
| [[File:gen5_unicode_9321.png]]
|- style="background: #eee;" align="center"
| ⑪
| 0x246a
| [[File:gen5_unicode_9322.png]]
|- style="background: #eee;" align="center"
| ⑫
| 0x246b
| [[File:9323.png]]
|- style="background: #eee;" align="center"
| ⑾
| 0x247e
| [[File:gen5_unicode_9312.png]]
|- style="background: #eee;" align="center"
| ⑿
| 0x247f
| [[File:gen5_unicode_9343.png]]
|- style="background: #eee;" align="center"
| ⒀
| 0x2480
| [[File:gen5_unicode_9344.png]]
|- style="background: #eee;" align="center"
| ⒁
| 0x2481
| [[File:9345.png]]
|- style="background: #eee;" align="center"
| ⒂
| 0x2482
| [[File:gen5_unicode_9346.png]]
|- style="background: #eee;" align="center"
| ⒃
| 0x2483
| [[File:gen5_unicode_9347.png]]
|- style="background: #eee;" align="center"
| ⒄
| 0x2484
| [[File:gen5_unicode_9348.png]]
|- style="background: #eee;" align="center"
| ⒅
| 0x2485
| [[File:9349.png]]
|- style="background: #eee;" align="center"
| ⒆
| 0x2486
| [[File:gen5_unicode_9350.png]]
|- style="background: #eee;" align="center"
| ⒇
| 0x2487
| [[File:gen5_unicode_9351.png]]
|- style="background: #eee;" align="center"
| ￢
| 0xffe2
| [[File:9314.png]]
|}

== Encounter Types ==

Encounter types are not used in Black and White. Pokeshifted Pokemon keep their Encounter Type hex.

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Value
! Country
|- style="background: #eee;" align="center"
| 0x0
| Pal Park, Egg, Hatched, Special Event
|- style="background: #ddd;" align="center"
| 0x2
| Tall Grass
|- style="background: #eee;" align="center"
| 0x4
| Dialga/Palkia In-Game Event
|- style="background: #ddd;" align="center"
| 0x5
| Cave, Hall of Origin
|- style="background: #eee;" align="center"
| 0x7
| Surfing, Fishing
|- style="background: #ddd;" align="center"
| 0x9
| Building
|- style="background: #eee;" align="center"
| 0xA
| Great Marsh (Safari Zone)
|- style="background: #ddd;" align="center"
| 0xC
| Starter, Fossil, Gift (Eevee)
|}

== Ribbons ==
Diamond, Pearl, and Platinum store the ribbon information as [[Bitfields|bitfields]] in 1-byte words. Given below are the bytewise representation of the ribbon bitfields.

=== Sinnoh Ribbon Set 1 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x01
| Sinnoh Champ Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x02
| Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x04
| Great Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x08
| Double Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x10
| Multi Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x20
| Pair Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x40
| World Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x80
| Alert Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x01
| Shock Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x02
| Downcast Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x04
| Careless Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x08
| Relax Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x10
| Snooze Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x20
| Smile Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x40
| Gorgeous Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x80
| Royal Ribbon
|}

=== Sinnoh Ribbon Set 2 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x01
| Gorgeous Royal Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x02
| Footprint Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x04
| Record Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x08
| History Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x10
| Legend Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x20
| Red Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x40
| Green Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x80
| Blue Ribbon
|- style="background: #eee;" align="center"
| 0x27 & 0x01
| Festival Ribbon
|- style="background: #ddd;" align="center"
| 0x27 & 0x02
| Carnival Ribbon
|- style="background: #eee;" align="center"
| 0x27 & 0x04
| Classic Ribbon
|- style="background: #ddd;" align="center"
| 0x27 & 0x08
| Premier Ribbon
|}

=== Sinnoh Ribbon Set 3 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x60 & 0x01
| Cool Ribbon
|- style="background: #ddd;" align="center"
| 0x60 & 0x02
| Cool Ribbon Great
|- style="background: #eee;" align="center"
| 0x60 & 0x04
| Cool Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x60 & 0x08
| Cool Ribbon Master
|- style="background: #eee;" align="center"
| 0x60 & 0x10
| Beauty Ribbon
|- style="background: #ddd;" align="center"
| 0x60 & 0x20
| Beauty Ribbon Great
|- style="background: #eee;" align="center"
| 0x60 & 0x40
| Beauty Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x60 & 0x80
| Beauty Ribbon Master
|- style="background: #eee;" align="center"
| 0x61 & 0x01
| Cute Ribbon
|- style="background: #ddd;" align="center"
| 0x61 & 0x02
| Cute Ribbon Great
|- style="background: #eee;" align="center"
| 0x61 & 0x04
| Cute Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x61 & 0x08
| Cute Ribbon Master
|- style="background: #eee;" align="center"
| 0x61 & 0x10
| Smart Ribbon
|- style="background: #ddd;" align="center"
| 0x61 & 0x20
| Smart Ribbon Great
|- style="background: #eee;" align="center"
| 0x61 & 0x40
| Smart Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x61 & 0x80
| Smart Ribbon Master
|}

=== Sinnoh Ribbon Set 4 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x62 & 0x01
| Tough Ribbon
|- style="background: #ddd;" align="center"
| 0x62 & 0x02
| Tough Ribbon Great
|- style="background: #eee;" align="center"
| 0x62 & 0x04
| Tough Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x62 & 0x08
| Tough Ribbon Master
|}

=== Hoenn Ribbon Set 1 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x3C & 0x01
| Cool Ribbon
|- style="background: #ddd;" align="center"
| 0x3C & 0x02
| Cool Ribbon Super
|- style="background: #eee;" align="center"
| 0x3C & 0x04
| Cool Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3C & 0x08
| Cool Ribbon Master
|- style="background: #eee;" align="center"
| 0x3C & 0x10
| Beauty Ribbon
|- style="background: #ddd;" align="center"
| 0x3C & 0x20
| Beauty Ribbon Super
|- style="background: #eee;" align="center"
| 0x3C & 0x40
| Beauty Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3C & 0x80
| Beauty Ribbon Master
|- style="background: #eee;" align="center"
| 0x3D & 0x01
| Cute Ribbon
|- style="background: #ddd;" align="center"
| 0x3D & 0x02
| Cute Ribbon Super
|- style="background: #eee;" align="center"
| 0x3D & 0x04
| Cute Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3D & 0x08
| Cute Ribbon Master
|- style="background: #eee;" align="center"
| 0x3D & 0x10
| Smart Ribbon
|- style="background: #ddd;" align="center"
| 0x3D & 0x20
| Smart Ribbon Super
|- style="background: #eee;" align="center"
| 0x3D & 0x40
| Smart Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3D & 0x80
| Smart Ribbon Master
|}

=== Hoenn Ribbon Set 2 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x3F & 0x01
| Tough Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x02
| Tough Ribbon Super
|- style="background: #eee;" align="center"
| 0x3F & 0x04
| Tough Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3F & 0x08
| Tough Ribbon Master
|- style="background: #eee;" align="center"
| 0x3F & 0x10
| Champion Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x20
| Winning Ribbon
|- style="background: #eee;" align="center"
| 0x3F & 0x40
| Victory Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x80
| Artist Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x01
| Effort Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x02
| Marine Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x04
| Land Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x08
| Sky Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x10
| Country Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x20
| National Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x40
| Earth Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x80
| World Ribbon
|}

== Save File Location ==
The party Pokémon are stored in the [[Pokémon NDS Save File Structure|save file]] beginning at offset 0x00098 for the first small block, and 0x40098 for the second small block.

In the first small save block, the first Daycare Pokémon is located at 0x0141C, and the second is located at 0x01508. In the second small block, the first Daycare Pokémon is located at 0x4141C, and the second is located at 0x41508.

In the first small save block, the Pal Park Pokémon are stored beginning at 0x0BA28. In the second small save block, the Pal Park Pokémon are stored beginning at 0x4BA28.

Each party and Daycare Pokémon is 220 bytes in size.

The PC storage Pokémon are stored in the save file from Box 1 to Box 18. The offset starts at 0x0C104 for the first big block and 0x4C104 for the second big block. Each PC stored Pokémon is 136 bytes in size.

[[Category:Structures]]
[[Category:Game Mechanics]]
[[Category:ROM Research]]

File:Gen5 unicode 9351.png

2011-04-13T00:25:49Z

Xfr: Mn symbol

== Summary ==
Mn symbol
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9350.png

2011-04-13T00:25:29Z

Xfr: Pk symbol

== Summary ==
Pk symbol
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9349.png

2011-04-13T00:25:08Z

Xfr: Exponent "e"

== Summary ==
Exponent "e"
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9348.png

2011-04-13T00:24:49Z

Xfr: Half-length sleep symbol

== Summary ==
Half-length sleep symbol
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9347.png

2011-04-13T00:24:29Z

Xfr: Half-length down arrow

== Summary ==
Half-length down arrow
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9346.png

2011-04-13T00:24:06Z

Xfr: Half-length up arrow

== Summary ==
Half-length up arrow
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9345.png

2011-04-13T00:23:42Z

Xfr: Half-length angry face

== Summary ==
Half-length angry face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9344.png

2011-04-13T00:23:20Z

Xfr: Half-length scared face

== Summary ==
Half-length scared face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9343.png

2011-04-13T00:22:55Z

Xfr: Half-width laughing face

== Summary ==
Half-width laughing face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9323.png

2011-04-13T00:21:39Z

Xfr: Exponent "r"

== Summary ==
Exponent "r"
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9322.png

2011-04-13T00:21:21Z

Xfr: Exponent "re"

== Summary ==
Exponent "re"
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9321.png

2011-04-13T00:21:00Z

Xfr: exponent "er"

== Summary ==
exponent "er"
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9314.png

2011-04-13T00:20:30Z

Xfr: Scared face

== Summary ==
Scared face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 9312.png

2011-04-13T00:19:20Z

Xfr: Smiling face 2

== Summary ==
Smiling face 2
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8744.png

2011-04-13T00:18:56Z

Xfr: Laughing face

== Summary ==
Laughing face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8743.png

2011-04-13T00:18:34Z

Xfr: Smiling face

== Summary ==
Smiling face
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8707.png

2011-04-13T00:18:13Z

Xfr: Sleep symol

== Summary ==
Sleep symol
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8704.png

2011-04-13T00:17:47Z

Xfr: Downwards-pointing arrow

== Summary ==
Downwards-pointing arrow
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8660.png

2011-04-13T00:17:13Z

Xfr: Upwards-pointing arrow

== Summary ==
Upwards-pointing arrow
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 8658.png

2011-04-13T00:16:35Z

Xfr: Angry-face smiley

== Summary ==
Angry-face smiley
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

File:Gen5 unicode 36.png

2011-04-13T00:15:51Z

Xfr: Pokédollar symbol

== Summary ==
Pokédollar symbol
== Copyright status: ==

== Licensing ==
{{Non-free game screenshot}}
== Source: ==
Pokémon Black

GTS protocol

2011-03-17T04:59:32Z

Xfr: Added gen5 server footer

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

In generation 5, the server must append to all its responses a footer generated by <code>sha1("HZEdGCzcGGLvguqUEKQN"+urlsafe_base64(response)+"HZEdGCzcGGLvguqUEKQN")</code>.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B-0x0C
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0B-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100-0x102
| Always 0
|- style="background: #ddd;" align="center"
| 0x103
| Unknown / seems to be 0x02?
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| Trainer class/sprite
|- style="background: #ddd;" align="center"
| 0x12F
| Always 0
|- style="background: #eee;" align="center"
| 0x130
| Game version
|- style="background: #ddd;" align="center"
| 0x131
| Region/language
|- style="background: #eee;" align="center"
| 0x132-0x137
| Always 0
|- style="background: #ddd;" align="center"
| 0x138-0x1B7
| Mystery data (encrypted?)
|- style="background: #eee;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| [[#Alternate Form|Alternate Form]]
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown'' - always 0?
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Alternate Form ===
The normal/default form is 0x01; if it is another form, this byte will correspond to the appropriate [[Pokemon Black/White NDS Structure#Alternate Forms|Pokémon structure alternate form]].

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

GTS protocol

2011-03-17T04:30:11Z

Xfr: Add deposit data offsets

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid (, length) and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''' other than searching, the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it via a trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

In generation 5, the sent data is 444 bytes long and as follows:

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x04
| Checksum (sum of all bytes xor 0x2db842b2)
|- style="background: #ddd;" align="center"
| 0x04-0x08
| pid
|- style="background: #eee;" align="center"
| 0x09-0x0A
| Data length (minus the 12 bytes of header)
|- style="background: #ddd;" align="center"
| 0x0B-0x0C
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0x0B-0xE8
| Encrypted [[Pokemon Black/White NDS Structure|party pokemon data structure]]
|- style="background: #ddd;" align="center"
| 0xE9-0xF7
| Unknown / Zero
|- style="background: #eee;" align="center"
| 0xF8-0x9
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0xFA
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0xFB
| Level
|- style="background: #ddd;" align="center"
| 0xFC-0xFD
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0xFE
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0xFF
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x100-0x102
| Always 0
|- style="background: #ddd;" align="center"
| 0x103
| Unknown / seems to be 0x02?
|- style="background: #eee;" align="center"
| 0x104-0x107
| Always 0?
|- style="background: #ddd;" align="center"
| 0x108-0x117
| Timestamp placeholder, always 0 (set by server)
|- style="background: #eee;" align="center"
| 0x118-0x119
| Trainer ID
|- style="background: #ddd;" align="center"
| 0x11A-0x11B
| Secret ID
|- style="background: #eee;" align="center"
| 0x11C-0x12B
| OT Name (Unicode, must end with 0xFFFF)
|- style="background: #ddd;" align="center"
| 0x12C
| Country
|- style="background: #eee;" align="center"
| 0x12D
| City
|- style="background: #ddd;" align="center"
| 0x12E
| Trainer class/sprite
|- style="background: #ddd;" align="center"
| 0x12F
| Always 0
|- style="background: #eee;" align="center"
| 0x130
| Game version
|- style="background: #ddd;" align="center"
| 0x131
| Region/language
|- style="background: #eee;" align="center"
| 0x132-0x137
| Always 0
|- style="background: #ddd;" align="center"
| 0x138-0x1B7
| Mystery data (encrypted?)
|- style="background: #eee;" align="center"
| 0x1B8-0x1BB
| Terminator (0x80000000)
|}

===Retrieving the deposited Pokémon===

Checking on the deposited Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the deposited Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| [[#Alternate Form|Alternate Form]]
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown'' - always 0?
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Alternate Form ===
The normal/default form is 0x01; if it is another form, this byte will correspond to the appropriate [[Pokemon Black/White NDS Structure#Alternate Forms|Pokémon structure alternate form]].

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}