BricksetAPIv2


Click here for a complete list of operations.

getSet

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
apiKey:
userHash:
SetID:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/v2.asmx HTTP/1.1
Host: brickset.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://brickset.com/api/getSet"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSet xmlns="https://brickset.com/api/">
      <apiKey>string</apiKey>
      <userHash>string</userHash>
      <SetID>string</SetID>
    </getSet>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSetResponse xmlns="https://brickset.com/api/">
      <getSetResult>
        <sets>
          <setID>int</setID>
          <number>string</number>
          <numberVariant>int</numberVariant>
          <name>string</name>
          <year>string</year>
          <theme>string</theme>
          <themeGroup>string</themeGroup>
          <subtheme>string</subtheme>
          <pieces>string</pieces>
          <minifigs>string</minifigs>
          <image>boolean</image>
          <imageFilename>string</imageFilename>
          <thumbnailURL>string</thumbnailURL>
          <largeThumbnailURL>string</largeThumbnailURL>
          <imageURL>string</imageURL>
          <bricksetURL>string</bricksetURL>
          <released>boolean</released>
          <owned>boolean</owned>
          <wanted>boolean</wanted>
          <qtyOwned>int</qtyOwned>
          <userNotes>string</userNotes>
          <ACMDataCount>int</ACMDataCount>
          <ownedByTotal>int</ownedByTotal>
          <wantedByTotal>int</wantedByTotal>
          <UKRetailPrice>string</UKRetailPrice>
          <USRetailPrice>string</USRetailPrice>
          <CARetailPrice>string</CARetailPrice>
          <EURetailPrice>string</EURetailPrice>
          <USDateAddedToSAH>string</USDateAddedToSAH>
          <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
          <rating>decimal</rating>
          <reviewCount>int</reviewCount>
          <packagingType>string</packagingType>
          <availability>string</availability>
          <instructionsCount>int</instructionsCount>
          <additionalImageCount>int</additionalImageCount>
          <ageMin>string</ageMin>
          <ageMax>string</ageMax>
          <height>string</height>
          <width>string</width>
          <depth>string</depth>
          <weight>string</weight>
          <category>string</category>
          <notes>string</notes>
          <userRating>string</userRating>
          <tags>string</tags>
          <EAN>string</EAN>
          <UPC>string</UPC>
          <description>string</description>
          <lastUpdated>dateTime</lastUpdated>
        </sets>
        <sets>
          <setID>int</setID>
          <number>string</number>
          <numberVariant>int</numberVariant>
          <name>string</name>
          <year>string</year>
          <theme>string</theme>
          <themeGroup>string</themeGroup>
          <subtheme>string</subtheme>
          <pieces>string</pieces>
          <minifigs>string</minifigs>
          <image>boolean</image>
          <imageFilename>string</imageFilename>
          <thumbnailURL>string</thumbnailURL>
          <largeThumbnailURL>string</largeThumbnailURL>
          <imageURL>string</imageURL>
          <bricksetURL>string</bricksetURL>
          <released>boolean</released>
          <owned>boolean</owned>
          <wanted>boolean</wanted>
          <qtyOwned>int</qtyOwned>
          <userNotes>string</userNotes>
          <ACMDataCount>int</ACMDataCount>
          <ownedByTotal>int</ownedByTotal>
          <wantedByTotal>int</wantedByTotal>
          <UKRetailPrice>string</UKRetailPrice>
          <USRetailPrice>string</USRetailPrice>
          <CARetailPrice>string</CARetailPrice>
          <EURetailPrice>string</EURetailPrice>
          <USDateAddedToSAH>string</USDateAddedToSAH>
          <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
          <rating>decimal</rating>
          <reviewCount>int</reviewCount>
          <packagingType>string</packagingType>
          <availability>string</availability>
          <instructionsCount>int</instructionsCount>
          <additionalImageCount>int</additionalImageCount>
          <ageMin>string</ageMin>
          <ageMax>string</ageMax>
          <height>string</height>
          <width>string</width>
          <depth>string</depth>
          <weight>string</weight>
          <category>string</category>
          <notes>string</notes>
          <userRating>string</userRating>
          <tags>string</tags>
          <EAN>string</EAN>
          <UPC>string</UPC>
          <description>string</description>
          <lastUpdated>dateTime</lastUpdated>
        </sets>
      </getSetResult>
    </getSetResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/v2.asmx HTTP/1.1
Host: brickset.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSet xmlns="https://brickset.com/api/">
      <apiKey>string</apiKey>
      <userHash>string</userHash>
      <SetID>string</SetID>
    </getSet>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSetResponse xmlns="https://brickset.com/api/">
      <getSetResult>
        <sets>
          <setID>int</setID>
          <number>string</number>
          <numberVariant>int</numberVariant>
          <name>string</name>
          <year>string</year>
          <theme>string</theme>
          <themeGroup>string</themeGroup>
          <subtheme>string</subtheme>
          <pieces>string</pieces>
          <minifigs>string</minifigs>
          <image>boolean</image>
          <imageFilename>string</imageFilename>
          <thumbnailURL>string</thumbnailURL>
          <largeThumbnailURL>string</largeThumbnailURL>
          <imageURL>string</imageURL>
          <bricksetURL>string</bricksetURL>
          <released>boolean</released>
          <owned>boolean</owned>
          <wanted>boolean</wanted>
          <qtyOwned>int</qtyOwned>
          <userNotes>string</userNotes>
          <ACMDataCount>int</ACMDataCount>
          <ownedByTotal>int</ownedByTotal>
          <wantedByTotal>int</wantedByTotal>
          <UKRetailPrice>string</UKRetailPrice>
          <USRetailPrice>string</USRetailPrice>
          <CARetailPrice>string</CARetailPrice>
          <EURetailPrice>string</EURetailPrice>
          <USDateAddedToSAH>string</USDateAddedToSAH>
          <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
          <rating>decimal</rating>
          <reviewCount>int</reviewCount>
          <packagingType>string</packagingType>
          <availability>string</availability>
          <instructionsCount>int</instructionsCount>
          <additionalImageCount>int</additionalImageCount>
          <ageMin>string</ageMin>
          <ageMax>string</ageMax>
          <height>string</height>
          <width>string</width>
          <depth>string</depth>
          <weight>string</weight>
          <category>string</category>
          <notes>string</notes>
          <userRating>string</userRating>
          <tags>string</tags>
          <EAN>string</EAN>
          <UPC>string</UPC>
          <description>string</description>
          <lastUpdated>dateTime</lastUpdated>
        </sets>
        <sets>
          <setID>int</setID>
          <number>string</number>
          <numberVariant>int</numberVariant>
          <name>string</name>
          <year>string</year>
          <theme>string</theme>
          <themeGroup>string</themeGroup>
          <subtheme>string</subtheme>
          <pieces>string</pieces>
          <minifigs>string</minifigs>
          <image>boolean</image>
          <imageFilename>string</imageFilename>
          <thumbnailURL>string</thumbnailURL>
          <largeThumbnailURL>string</largeThumbnailURL>
          <imageURL>string</imageURL>
          <bricksetURL>string</bricksetURL>
          <released>boolean</released>
          <owned>boolean</owned>
          <wanted>boolean</wanted>
          <qtyOwned>int</qtyOwned>
          <userNotes>string</userNotes>
          <ACMDataCount>int</ACMDataCount>
          <ownedByTotal>int</ownedByTotal>
          <wantedByTotal>int</wantedByTotal>
          <UKRetailPrice>string</UKRetailPrice>
          <USRetailPrice>string</USRetailPrice>
          <CARetailPrice>string</CARetailPrice>
          <EURetailPrice>string</EURetailPrice>
          <USDateAddedToSAH>string</USDateAddedToSAH>
          <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
          <rating>decimal</rating>
          <reviewCount>int</reviewCount>
          <packagingType>string</packagingType>
          <availability>string</availability>
          <instructionsCount>int</instructionsCount>
          <additionalImageCount>int</additionalImageCount>
          <ageMin>string</ageMin>
          <ageMax>string</ageMax>
          <height>string</height>
          <width>string</width>
          <depth>string</depth>
          <weight>string</weight>
          <category>string</category>
          <notes>string</notes>
          <userRating>string</userRating>
          <tags>string</tags>
          <EAN>string</EAN>
          <UPC>string</UPC>
          <description>string</description>
          <lastUpdated>dateTime</lastUpdated>
        </sets>
      </getSetResult>
    </getSetResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/v2.asmx/getSet?apiKey=string&userHash=string&SetID=string HTTP/1.1
Host: brickset.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSets xmlns="https://brickset.com/api/">
  <sets>
    <setID>int</setID>
    <number>string</number>
    <numberVariant>int</numberVariant>
    <name>string</name>
    <year>string</year>
    <theme>string</theme>
    <themeGroup>string</themeGroup>
    <subtheme>string</subtheme>
    <pieces>string</pieces>
    <minifigs>string</minifigs>
    <image>boolean</image>
    <imageFilename>string</imageFilename>
    <thumbnailURL>string</thumbnailURL>
    <largeThumbnailURL>string</largeThumbnailURL>
    <imageURL>string</imageURL>
    <bricksetURL>string</bricksetURL>
    <released>boolean</released>
    <owned>boolean</owned>
    <wanted>boolean</wanted>
    <qtyOwned>int</qtyOwned>
    <userNotes>string</userNotes>
    <ACMDataCount>int</ACMDataCount>
    <ownedByTotal>int</ownedByTotal>
    <wantedByTotal>int</wantedByTotal>
    <UKRetailPrice>string</UKRetailPrice>
    <USRetailPrice>string</USRetailPrice>
    <CARetailPrice>string</CARetailPrice>
    <EURetailPrice>string</EURetailPrice>
    <USDateAddedToSAH>string</USDateAddedToSAH>
    <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
    <rating>decimal</rating>
    <reviewCount>int</reviewCount>
    <packagingType>string</packagingType>
    <availability>string</availability>
    <instructionsCount>int</instructionsCount>
    <additionalImageCount>int</additionalImageCount>
    <ageMin>string</ageMin>
    <ageMax>string</ageMax>
    <height>string</height>
    <width>string</width>
    <depth>string</depth>
    <weight>string</weight>
    <category>string</category>
    <notes>string</notes>
    <userRating>string</userRating>
    <tags>string</tags>
    <EAN>string</EAN>
    <UPC>string</UPC>
    <description>string</description>
    <lastUpdated>dateTime</lastUpdated>
  </sets>
  <sets>
    <setID>int</setID>
    <number>string</number>
    <numberVariant>int</numberVariant>
    <name>string</name>
    <year>string</year>
    <theme>string</theme>
    <themeGroup>string</themeGroup>
    <subtheme>string</subtheme>
    <pieces>string</pieces>
    <minifigs>string</minifigs>
    <image>boolean</image>
    <imageFilename>string</imageFilename>
    <thumbnailURL>string</thumbnailURL>
    <largeThumbnailURL>string</largeThumbnailURL>
    <imageURL>string</imageURL>
    <bricksetURL>string</bricksetURL>
    <released>boolean</released>
    <owned>boolean</owned>
    <wanted>boolean</wanted>
    <qtyOwned>int</qtyOwned>
    <userNotes>string</userNotes>
    <ACMDataCount>int</ACMDataCount>
    <ownedByTotal>int</ownedByTotal>
    <wantedByTotal>int</wantedByTotal>
    <UKRetailPrice>string</UKRetailPrice>
    <USRetailPrice>string</USRetailPrice>
    <CARetailPrice>string</CARetailPrice>
    <EURetailPrice>string</EURetailPrice>
    <USDateAddedToSAH>string</USDateAddedToSAH>
    <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
    <rating>decimal</rating>
    <reviewCount>int</reviewCount>
    <packagingType>string</packagingType>
    <availability>string</availability>
    <instructionsCount>int</instructionsCount>
    <additionalImageCount>int</additionalImageCount>
    <ageMin>string</ageMin>
    <ageMax>string</ageMax>
    <height>string</height>
    <width>string</width>
    <depth>string</depth>
    <weight>string</weight>
    <category>string</category>
    <notes>string</notes>
    <userRating>string</userRating>
    <tags>string</tags>
    <EAN>string</EAN>
    <UPC>string</UPC>
    <description>string</description>
    <lastUpdated>dateTime</lastUpdated>
  </sets>
</ArrayOfSets>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/v2.asmx/getSet HTTP/1.1
Host: brickset.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiKey=string&userHash=string&SetID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSets xmlns="https://brickset.com/api/">
  <sets>
    <setID>int</setID>
    <number>string</number>
    <numberVariant>int</numberVariant>
    <name>string</name>
    <year>string</year>
    <theme>string</theme>
    <themeGroup>string</themeGroup>
    <subtheme>string</subtheme>
    <pieces>string</pieces>
    <minifigs>string</minifigs>
    <image>boolean</image>
    <imageFilename>string</imageFilename>
    <thumbnailURL>string</thumbnailURL>
    <largeThumbnailURL>string</largeThumbnailURL>
    <imageURL>string</imageURL>
    <bricksetURL>string</bricksetURL>
    <released>boolean</released>
    <owned>boolean</owned>
    <wanted>boolean</wanted>
    <qtyOwned>int</qtyOwned>
    <userNotes>string</userNotes>
    <ACMDataCount>int</ACMDataCount>
    <ownedByTotal>int</ownedByTotal>
    <wantedByTotal>int</wantedByTotal>
    <UKRetailPrice>string</UKRetailPrice>
    <USRetailPrice>string</USRetailPrice>
    <CARetailPrice>string</CARetailPrice>
    <EURetailPrice>string</EURetailPrice>
    <USDateAddedToSAH>string</USDateAddedToSAH>
    <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
    <rating>decimal</rating>
    <reviewCount>int</reviewCount>
    <packagingType>string</packagingType>
    <availability>string</availability>
    <instructionsCount>int</instructionsCount>
    <additionalImageCount>int</additionalImageCount>
    <ageMin>string</ageMin>
    <ageMax>string</ageMax>
    <height>string</height>
    <width>string</width>
    <depth>string</depth>
    <weight>string</weight>
    <category>string</category>
    <notes>string</notes>
    <userRating>string</userRating>
    <tags>string</tags>
    <EAN>string</EAN>
    <UPC>string</UPC>
    <description>string</description>
    <lastUpdated>dateTime</lastUpdated>
  </sets>
  <sets>
    <setID>int</setID>
    <number>string</number>
    <numberVariant>int</numberVariant>
    <name>string</name>
    <year>string</year>
    <theme>string</theme>
    <themeGroup>string</themeGroup>
    <subtheme>string</subtheme>
    <pieces>string</pieces>
    <minifigs>string</minifigs>
    <image>boolean</image>
    <imageFilename>string</imageFilename>
    <thumbnailURL>string</thumbnailURL>
    <largeThumbnailURL>string</largeThumbnailURL>
    <imageURL>string</imageURL>
    <bricksetURL>string</bricksetURL>
    <released>boolean</released>
    <owned>boolean</owned>
    <wanted>boolean</wanted>
    <qtyOwned>int</qtyOwned>
    <userNotes>string</userNotes>
    <ACMDataCount>int</ACMDataCount>
    <ownedByTotal>int</ownedByTotal>
    <wantedByTotal>int</wantedByTotal>
    <UKRetailPrice>string</UKRetailPrice>
    <USRetailPrice>string</USRetailPrice>
    <CARetailPrice>string</CARetailPrice>
    <EURetailPrice>string</EURetailPrice>
    <USDateAddedToSAH>string</USDateAddedToSAH>
    <USDateRemovedFromSAH>string</USDateRemovedFromSAH>
    <rating>decimal</rating>
    <reviewCount>int</reviewCount>
    <packagingType>string</packagingType>
    <availability>string</availability>
    <instructionsCount>int</instructionsCount>
    <additionalImageCount>int</additionalImageCount>
    <ageMin>string</ageMin>
    <ageMax>string</ageMax>
    <height>string</height>
    <width>string</width>
    <depth>string</depth>
    <weight>string</weight>
    <category>string</category>
    <notes>string</notes>
    <userRating>string</userRating>
    <tags>string</tags>
    <EAN>string</EAN>
    <UPC>string</UPC>
    <description>string</description>
    <lastUpdated>dateTime</lastUpdated>
  </sets>
</ArrayOfSets>