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