Rebrickable API Documentation | Rebrickable

Error - This API is no longer available

This API is no longer available. This documentation is only here to help facilitate upgrading to the newer v3 API.

These API functions should be called via a URL matching the format: https://rebrickable.com/api/{function}

get_user_hash

Use this service to get a user's hash key. This is a 32-character key which can be used instead of an email/password combination when calling any of the below API functions. It is designed to prevent having to store passwords in external applications. The user's hash key is valid until the user changes their email address or password. Details

get_user_details

Use this service to get various user details and statistics. Details

get_set_match

Use this service to find out how many parts the user needs to build the specified set. This will use any sets and loose parts the user has configured in their account. It returns two numbers - the total number of parts in the set and the number of parts the user is missing - so you can calculate the % yourself. Details

get_user_setlists

Use this service to get the user's Set Lists. This can be used with get_user_sets to get the full list of sets for each setlist. Details

add_user_setlist

Use this service to create a new Set List for the user. Details

del_user_setlist

Use this service to delete a Set List from the user. If there are still sets in the set list, they will also be removed. Details

get_user_sets

Use this service to get all the sets saved in the specified user's Set Lists. Details

set_user_sets

Use this service to set the Rebrickable sets saved in the specified user's My Sets list. It will merge these sets with any existing sets. However if you specify the optional setlist_id parameter, it will instead replace (ie not merge) all sets just in that specific set list. If any sets cannot be found in the database, they will be silently ignored. For this reason, when it has finished it will return the number of sets that were successfully recognised. Details

get_user_set

Use this service to get a single set saved in the specified user's Sets, optionally provide a Set List ID to limit the count to that set list. If they don't have the set, it will return a quantity of 0. Details

set_user_set

Use this service to set the quantity of a single set saved in the specified user's My Sets list. Use 0 to delete the set. If the user does not have the set, it will add the specific number of them. Details

get_user_part_lists

Use this service to get a user's part lists as shown on their My Parts page. Further calls to get_user_parts can use the IDs returned here. Details

add_user_partlist

Use this service to create a new Part List for the user. Details

del_user_partlist

Use this service to delete a Part List from the user. If there are still parts in the part list, they will also be removed. Details

get_user_parts

Use this service to get a user's list of loose parts as shown on their My Parts page. Details

set_user_parts

Use this service to set the list of loose parts saved in the specified user's My Parts list. It will first delete any existing parts, so you should always pass in the complete list. If any parts cannot be found in the database, they will be silently ignored. The usual translation of part IDs will occur as per any parts import process (e.g. Bricklink part numbers converted to LDraw where they are different). It will return the number of parts that were successfully recognised. Details

get_user_parts_color_summary

Use this service to get a user's summary of number of owned parts per color. Details

get_user_lost_parts

Use this service to get a user's list of lost parts as shown on their My Lost Parts page. Details

set_user_lost_parts

Use this service to set the list of lost parts shown in user's My Lost Parts list. It will first delete any existing parts, so you should always pass in the complete list. If any parts cannot be found in the database, they will be silently ignored. It will return the number of parts that were successfully recognised. Details

get_user_set_lost_parts

Use this service to get a user's list of lost parts from a specific set, as shown on their My Lost Parts page. Details

set_user_set_lost_parts

Use this service to set the list of lost parts for a specific set id as shown in user's My Lost Parts list. It will first delete any existing parts for that set, so you should always pass in the complete list for that set. If any parts cannot be found in the database, they will be silently ignored. It will return the number of parts that were successfully recognised. Details

get_set_parts

Use this service to get a list of all parts in a set. It includes both normal and spare parts. Details

get_part

Use this service to get details about a part, such as its name, number of sets it appears in, which colors it appears in, etc. Relationships provide a list of printed parts, different molds etc. External IDs provide a list of the part ids for other systems where they are different to Rebrickable, such as Bricklink, Peeron, LDraw or LEGO element IDs. If the field rebrickable_part_id exists, that means this part is not used in any Rebrickable inventories and you should use the specified part instead. Details

get_element

Use this service to get a part's design id and color based on a LEGO element id. Details

get_set

Use this service to get details about a set. Details

get_part_sets

Use this service to get a list of all sets that a specific part/color combination appears in. This is best used after calling the get_part function to retrieve the list of available colors. Details

get_colors

Use this service to get a list of all the colors used by parts in the database. Details

get_changes

Get a list of all changes (sets, mocs, parts, inventories) since a point in time. Use this to apply delta changes within your app/site instead of downloading the entire catalog. Max entries returned is 1000. Details

get_alt_builds

Get a list of any alternate build MOCs based on a specific set. These MOCs use only the parts from a single set. Details

get_part_types

Use this service to get a list of the part type categories. Details

get_themes

Use this service to get a list of the set theme ids/descriptions. Details

search

Get a list of Sets/MOCs/Parts that match the search criteria. Max entries returned is 1000. Details

URL	/api/search
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name type - Filter on only S=Sets, M=MOCs, P=Parts. query - General search query. Search terms are additive. theme1 - Set Filter: Theme Level 1 theme2 - Set Filter: Theme Level 2 theme3 - Set Filter: Theme Level 3 min_pieces - Set Filter: List sets with >= this number of parts. max_pieces - Set Filter: List sets with <= this number of parts. min_year - Set Filter: List sets released >= this year. max_year - Set Filter: List sets released <= this year. part_type_id - Part Filter: Only list parts with this type/category ID. part_color - Part Filter: Only list parts that appear in this color.
Returns	Output data with fields: set_id - Set ID. year - Set: Year released. pieces - Set: Number of parts in the set. theme1 - Set: Theme category level 1. theme2 - Set: Theme category level 2. theme3 - Set: Theme category level 3. accessory - Set: Does this set have accessory/supplemental parts. kit - Set: Is this set a kit (set of sets). descr - Set: Description. url - Set: Rebrickable URL for the set. part_id - Part: Part ID. descr - Part: Part description. part_type - Part: Part type description. part_type_id - Part: Part type ID. num_parts - Part: Number of times this part appears in all sets. num_sets - Part: Number of sets this part appears in. num_colors - Part: Number of colors this part appears in. min_year - Part: First year this part appeared. max_year - Part: Last year this part appeared. url - Part: Rebrickable URL for the part. img_url - Part: URL of the part image img_tn - Set: URL of the thumbnail set image img_sm - Set: URL of the small set image img_big - Set: URL of the big set image Error Codes: INVALIDKEY - The API Key is invalid

URL	/api/get_user_hash
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password.
Returns	Output data with fields: N/A - 32 character hash key uniquely identifying and authenticating the user Error Codes: INVALIDKEY - The API Key is invalid INVALIDUSERPASS - Invalid user email or password

URL	/api/get_user_details
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass.
Returns	Output data with fields: user_id - User ID username - Username realname - Real name as per user's profile. last_activity - Timestamp of the last website activity for the user last_ip - The IP that the user was last seen using the website avatar_url - URL for the user's avatar image location - Location field on user's profile. karma - Karma points earned by the user. total_sets - Total number of sets in the user's set lists. unique_sets - Number of unique sets in the user's set lists. set_parts - Number of parts across all of the sets in the user's set lists. loose_parts - Number of parts in the user's loose parts lists. unique_parts - Number of unique parts in the user's loose parts lists. last_inv_modified - The date/time of the last change to the user's collection, either sets or loose parts. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password

URL	/api/get_set_match
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. set - The Set ID to check.
Returns	Output data with fields: last_modified - Timestamp (YYYY-MM-DD HH24:MI:SS) in UTC Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found NOSET - The set could not be found

URL	/api/get_user_setlists
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. set_id - Optionally only return set lists that contain this set id.
Returns	Output data with fields: setlist_id - Set List ID name - Name of the set list. type - Type of set list (1 = Use in Builds, 2 = Don't use in Builds). Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/add_user_setlist
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. descr - Description/Name of the set list. type - Type of set list: 1 = use sets in build, 2 = dont use sets in build calculations.
Returns	Output data with fields: SUCCESS - Successfully added the setlist and returns the setlist_id. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/del_user_setlist
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. setlist_id - The Set List ID.
Returns	Output data with fields: SUCCESS - Successfully deleted the setlist. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_sets
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. setlist_id - The ID of the user's set list to retrieve (leave out to combine all setlists)
Returns	Output data with fields: set_id - Set ID qty - Number of sets the user owns. pieces - Number of parts in the set. descr - Set description. year - Year the set was released. img_tn - Set image URL - tiny img_sm - Set image URL - small Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/set_user_sets
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. sets - The list of sets to be added: SET QTY, SET QTY, etc setlist_id - The ID of the user's set list to add to (optional)
Returns	Output data with fields: N/A - Successfully added the indicated number of sets Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_set
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. set - The Set ID to look up (e.g. 8258-1) setlist_id - Optional Set List ID to query
Returns	Output data with fields: N/A - The number of sets owned by the user. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found NOSET - The set could not be found

URL	/api/set_user_set
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. set - The Set ID to be updated qty - The new quantity (0 to delete it) setlist_id - The set list to modify (default 1)
Returns	Output data with fields: SUCCESS - Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_part_lists
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass.
Returns	Output data with fields: partlist_id - Part List ID. descr - Description of Part List. type - Type of list - 1 = Used in Builds, 2 = Not Used in Builds. qty - The number of parts in the part list. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/add_user_partlist
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. descr - Description/Name of the part list. type - Type of part list: 1 = use parts in build, 2 = dont use parts in build calculations.
Returns	Output data with fields: SUCCESS - Successfully added the setlist and returns the setlist_id. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/del_user_partlist
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. partlist_id - The Part List ID.
Returns	Output data with fields: SUCCESS - Successfully deleted the partlist. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_parts
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. partlist_id - Optional Part List ID, default is to return all parts across all parts lists.
Returns	Output data with fields: part_id - Part ID. rb_color_id - Color ID. ldraw_color_id - LDraw Color ID. qty - The number of this part owned by the user. part_name - The part name. part_type_id - The part type/category id. part_url - The URL of the part details. part_img_url - The best avaialble image for the part. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/set_user_parts
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. parts - The list of parts to be added: PART COLOR QTY, PART COLOR QTY, etc partlist_id - Optional Part List ID, default is to use the first list.
Returns	Output data with fields: SUCCESS [int parts added] - Successfully added the indicated number of parts Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_parts_color_summary
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. part_id - The Part ID to lookup.
Returns	Output data with fields: rb_color_id - Color ID. num_in_sets - The number of times this part/color occurs in sets owned by the user. num_in_parts - The number of times this part/color occurs in loose parts owned by the user. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/get_user_lost_parts
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass.
Returns	Output data with fields: part_id - Part ID. set_id - Set ID. rb_color_id - Color ID. ldraw_color_id - LDraw Color ID. qty - The number of this part owned by the user. part_name - The part name. part_type_id - The part type/category id. part_url - The URL of the part details. part_img_url - The best avaialble image for the part. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/set_user_lost_parts
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. parts - The list of parts to be added: PART SET COLOR QTY, PART SET COLOR QTY, etc
Returns	Output data with fields: SUCCESS [int parts added] - Successfully added the indicated number of parts Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password INVALIDPARTS - Invalid format for the list of parts NOUSER - The user could not be found

URL	/api/get_user_set_lost_parts
Method	GET
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. set_id - Set number to lookup.
Returns	Output data with fields: part_id - Part ID. rb_color_id - Color ID. ldraw_color_id - LDraw Color ID. qty - The number of this part owned by the user. part_name - The part name. part_type_id - The part type/category id. Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password NOUSER - The user could not be found

URL	/api/set_user_set_lost_parts
Method	POST
Parameters	key - API Key format - How to display output data. Valid values: xml, json, csv, tsv callback - Optional JSONP callback function name email - The user's logon email. pass - The user's password. hash - User Hash Key, alternate to providing email+pass. parts - The list of parts to be added: PART COLOR QTY, PART COLOR QTY, etc set_id - Set number to add lost parts to.
Returns	Output data with fields: SUCCESS [int parts added] - Successfully added the indicated number of parts Error Codes: INVALIDKEY - The API Key is invalid INVALIDPASS - Invalid user email or password INVALIDHASH - The hash key does not match a user/password INVALIDPARTS - Invalid format for the list of parts NOUSER - The user could not be found

API v2