ProjectPokemon Wiki - User contributions [en]

GTS protocol

2011-04-13T04:43:37Z

Willaien:

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/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
| 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?
|}

=== 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-13T04:42:31Z

Willaien: Typo fixed in table.

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"
| 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/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
| 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?
|}

=== 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
|}