--- title: "How do I list or find instruments mastered in LUSID?" slug: "how-do-i-list-or-find-instruments-mastered-in-lusid" updated: 2024-08-22T08:22:08Z published: 2024-08-22T08:22:08Z canonical: "support.lusid.com/how-do-i-list-or-find-instruments-mastered-in-lusid" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.lusid.com/llms.txt > Use this file to discover all available pages before exploring further. # How do I list or find instruments mastered in LUSID? You can search or [filter](/v1/docs/filtering-information-retrieved-from-lusid) the LUSID instrument master to find a particular financial asset. Note your LUSID instrument master may be partitioned into [scopes](/v1/docs/understanding-instrument-scopes). If so, then you must specify the scope in which to search; if you do not, LUSID searches only the built-in `default` scope. If you *have* partitioned your instrument master, it is not possible to search across all scopes. Note currency instruments only exist in the `default` scope. ## Using the LUSID REST API To call any LUSID API, you must [obtain an API access token](/v1/docs/how-do-i-obtain-and-use-a-short-lived-api-access-token-from-okta). ### Listing instruments in the built-in default scope To list all instruments in the `default` scope, call the [ListInstruments](https://www.lusid.com/docs/api#operation/ListInstruments) API for your domain, passing in your API access token. Note only 100 instruments are returned per page; to increase this to the maximum per page, specify a limit of 2000: ```json curl -X GET "https://.lusid.com/api/api/instruments?limit=2000"  -H "Authorization: Bearer " ``` To list all the instruments that are not currencies, [apply a filter](/v1/docs/filtering-information-retrieved-from-lusid) of `identifiers['Currency'] not exists`: ```json curl -X GET "https://.lusid.com/api/api/instruments?limit=2000&filter=identifiers%5B%27Currency%27%5D%20not%20exists"  -H "Authorization: Bearer " ``` To list all the instruments that are of type `Bond` or `ComplexBond`, apply a filter of `instrumentDefinition.instrumentType in 'Bond', 'ComplexBond'`: ```json curl -X GET "https://.lusid.com/api/api/instruments?filter=instrumentDefinition.instrumentType%20in%20%27Bond%27%2C%27ComplexBond%27"  -H "Authorization: Bearer " ``` To list all the deactivated instruments, apply a filter of `State eq 'Inactive'`: ```json curl -X GET "https://.lusid.com/api/api/instruments?filter=State%20eq%20%27Inactive%27"  -H "Authorization: Bearer " ``` ### Listing instruments in a custom scope Call the [ListInstruments](https://www.lusid.com/docs/api#operation/ListInstruments) API for your domain, passing in your API access token and the name of the scope: ```json curl -X GET "https://.lusid.com/api/api/instruments?scope=mysecretscope"  -H "Authorization: Bearer " ``` ### Retrieving a particular instrument To get a particular instrument, call the [GetInstrument](https://www.lusid.com/docs/api#operation/GetInstrument) API, passing in a [unique identifier](/v1/docs/what-are-unique-and-non-unique-identifiers) type and value, for example a FIGI or LUID: ```json curl -X GET "https://.lusid.com/api/api/instruments/Figi/BBG000C05BD1"  -H "Authorization: Bearer " ``` ### Searching LUSID and OpenFIGI simultaneously You can search both the LUSID instrument master and the [OpenFIGI](https://www.openfigi.com/) database simultaneously. This has the advantage of enabling you to quickly populate the LUSID instrument master from OpenFIGI if a particular instrument is found in the latter but not in the former. To do this, call the [SearchInstruments](https://www.lusid.com/docs/api#operation/InstrumentsSearch) API, passing in a FIGI [unique identifier](/v1/docs/what-are-unique-and-non-unique-identifiers) type and value: ```json curl -X POST "https://.lusid.com/api/api/search/instruments"  -H "Authorization: Bearer "  -H "Content-Type: application/json"  -d '[ { "key": "Instrument/default/Figi", "value": "BBG000C05BD1" } ]' ``` In this example, the response within the `externalInstruments` list is ready to be [upserted](/v1/docs/how-do-i-master-an-instrument#using-the-lusid-api) using the [UpsertInstruments](https://www.lusid.com/docs/api#operation/UpsertInstruments) API: ```json [   {       "masteredInstruments": [],       "externalInstruments": [           {               "name": "BP PLC",               "identifiers": {                   "Figi": {                       "value": "BBG000C05BD1",                       "effectiveAt": "0001-01-01T00:00:00.0000000+00:00"                   }               },               "properties": [                   {                       "key": "Instrument/default/CompositeFigi",                       "value": {                           "labelValue": "BBG000C059M6"                       },                       "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"                   },                   {                       "key": "Instrument/default/ShareClassFigi",                       "value": {                           "labelValue": "BBG001S61CN0"                       },                       "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"                   },                   {                       "key": "Instrument/default/Ticker",                       "value": {                           "labelValue": "BP/"                       },                       "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"                   }               ]           }       ]   } ] ``` ## Using the LUSID web app Sign in to the [LUSID web app](https://www.lusid.com/app) using the credentials of a LUSID administrator. You can enter a term in the instrument search box (top left): ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/d4f0825b-0d1d-4af9-ae42-269efecd989c.png) Alternatively, you can select **Data Management > Instruments** from the left-hand menu to navigate to the **Instruments** dashboard, and enter a term in any column header to start filtering the instrument list. Note that to see the dashboard as it is here, with the unique and non-unique [identifiers](/v1/docs/understanding-instrument-identifiers) displayed in columns, click the **Configuration** cog (top right) and choose to add columns consisting of all the instrument identifiers. Identifiers with a * in the column header are [unique](/v1/docs/what-are-unique-and-non-unique-identifiers): ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/b12c3a15-7657-433e-b497-514e01e2b986.png)