API version 3 documentation

The API provides a robust means of interfacing with Brickset and now provides responses in JSON making it much easier to use and integrate into your application.

Accessing the API

The API endpoint is https://brickset.com/api/v3.asmx. Methods are invoked using the format https://brickset.com/api/v3.asmx/{method}, e.g. https://brickset.com/api/v3.asmx/getSets.

Parameters can be specified on the URL (e.g. GET) or POSTed but in some cases they'll need to be POSTed due to restrictions on URL length and allowed characters in them.

Methods beginning with get are used to retrieve data. Those beginning with set are used to make changes to a user's collection information.

All methods require a valid API key to be passed, which can be obtained here.

Methods

You can click on a method name to test it.

JSON parameters

Parameters to influence results or to specify database updates are passed as a JSON string in the format {'parameter':'value',...}.

All are optional but at least one must be used to retrieve results or make updates.

For example, for the getSets method:

• {'theme':'space','year':'1978,1979'}
• {'theme':'Pirates','owned':1}
• {'year':'2020','orderBy':'Pieces','pageSize':100}
• {'tag':'crane','theme':'Technic','extendedData':1}

Class definitions

Sets

Class sets
    Public setID As Integer
    Public number As String
    Public numberVariant As Integer
    Public name As String
    Public year As Integer
    Public theme As String
    Public themeGroup As String
    Public subtheme As String
    Public category As String
    Public released As Boolean
    Public pieces As Integer?
    Public minifigs As Integer?
    Public image As New image
    Public bricksetURL As String
    Public collection As New collection
    Public collections As New collections
    Public LEGOCom As New LEGOCom
    Public rating As Single
    Public reviewCount As integer
    Public launchDate as DateTime?
    Public exitDate as DateTime?
    Public packagingType As String
    Public availability As String
    Public instructionsCount As Integer
    Public additionalImageCount As Integer
    Public ageRange As New ageRange
    Public dimensions As New dimensions
    Public modelDimensions As New modelDimensions
    Public barcode As New barcodes
    Public itemNumber As New itemNumbers
    Public extendedData As New extendedData
    Public lastUpdated As DateTime
End Class

Class LEGOCom
    Public US As New LEGOComDetails
    Public UK As New LEGOComDetails
    Public CA As New LEGOComDetails
    Public DE As New LEGOComDetails
End Class

Class LEGOComDetails
    Public retailPrice As Decimal?
    Public dateFirstAvailable As DateTime?
    Public dateLastAvailable As DateTime?
End Class

Class dimensions
    Public height As Single?
    Public width As Single?
    Public depth As Single?
    Public weight As Single?
End Class

Class modelDimensions
    Public dimension1 As Single?
    Public dimension2 As Single?
    Public dimension3 As Single?
End Class

Class extendedData
    Public notes As String
    Public tags() As String
    Public description As String
End Class

Class collection
    Public owned As Boolean?
    Public wanted As Boolean?
    Public qtyOwned As Integer?
    Public rating As Integer?
    Public notes As String
End Class

Class collections
    Public ownedBy As Integer?
    Public wantedBy As Integer?
End Class

Class barcodes
    Public EAN As String
    Public UPC As String
End Class

Class itemNumbers
     Public NA As String
     Public EU As String
End Class

Class ageRange
    Public min As Integer?
    Public max As Integer?
End Class

Class image
    Public thumbnailURL As String
    Public imageURL As String
End Class

Other classes

Class rating
    Public overall As Integer
    Public parts As Integer
    Public buildingExperience As Integer
    Public playability As Integer
    Public valueForMoney As Integer
End Class

Class reviews
    Public author As String
    Public datePosted As Date
    Public rating As rating
    Public title As String
    Public review As String
    Public HTML As Boolean
End Class

Class minifigCollection
    Public minifigNumber As String
    Public name as String
    Public category as String
    Public ownedInSets As Integer
    Public ownedLoose As Integer
    Public ownedTotal As Integer
    Public wanted As Boolean
End Class

Class themes
    Public theme As String
    Public setCount As Integer
    Public subthemeCount As Integer
    Public yearFrom As Integer
    Public yearTo As Integer
End Class

Class subthemes
    Public theme As String
    Public subtheme As String
    Public setCount As Integer
    Public yearFrom As Integer
    Public yearTo As Integer
End Class

Class years
    Public theme As String
    Public year As String
    Public setCount As Integer
End Class

Class instructions
    Public URL As String
    Public description As String
End Class

Class userNotes
    Public setID As Integer
    Public notes As String
End Class

Class userMinifigNotes 
    Public minifigNumber As String
    Public notes As String
End Class

Class apiKeyUsage
    Public dateStamp As Date
    Public count As Integer
End Class

Change log