Get Security Master Reference data

Perform a search for securities using a ticker or other search criteria.

Response (200 OK)

{
    "error": null,
    "message": "success",
        "data": {
        "facet_counts": [],
        "found": 4,
        "hits": [
            {
                "document": {
                    "MIC": "XSWX",
                    "compositefigi": "BBG01K1ZGNY0",
                    "exchcode": "SE",
                    "figi": "BBG01K1ZGP02",
                    "id": "616657",
                    "marketsector": "Equity",
                    "name": "WILL SEMICONDUCTOR CO LT-GDR",
                    "name2": "Will Semiconductor Co Lt-Gdr",
                    "securitydescription": "WILL",
                    "securitytype": "GDR",
                    "securitytype2": "Depositary Receipt",
                    "shareclassfigi": "BBG01K1ZGP57",
                    "ticker": "WILL"
                },
                "highlight": {
                    "ticker": {
                        "matched_tokens": [
                            "WILL"
                        ],
                        "snippet": "<mark>WILL</mark>"
                    }
                },
                "highlights": [
                    {
                        "field": "ticker",
                        "matched_tokens": [
                            "WILL"
                        ],
                        "snippet": "<mark>WILL</mark>"
                    }
                ],
                "text_match": 578730123365711993
            },
            {
                "document": {
                    "MIC": "TRQX",
                    "compositefigi": "BBG00GMB6446",
                    "exchcode": "TQ",
                    "figi": "BBG00GMB6455",
                    "id": "49391",
                    "marketsector": "Equity",
                    "name": "WILMINGTON PLC",
                    "name2": "Wilmington Plc",
                    "securitydescription": "WILL",
                    "securitytype": "Common Stock",
                    "securitytype2": "Common Stock",
                    "shareclassfigi": "BBG001S8PH77",
                    "ticker": "WILL"
                },
                "highlight": {
                    "ticker": {
                        "matched_tokens": [
                            "WILL"
                        ],
                        "snippet": "<mark>WILL</mark>"
                    }
                },
                "highlights": [
                    {
                        "field": "ticker",
                            "matched_tokens": [
                                "WILL"
                            ],
                        "snippet": "<mark>WILL</mark>"
                    }
                ],
                "text_match": 578730123365711993
            },
            {
                "document": {
                    "MIC": "TREA",
                    "compositefigi": "BBG01K4DKF78",
                    "exchcode": "XZ",
                    "figi": "BBG01K4DKG12",
                    "id": "610161",
                    "marketsector": "Equity",
                    "name": "WILL SEMICONDUCTOR CO LT-GDR",
                    "name2": "Will Semiconductor Co Lt-Gdr",
                    "securitydescription": "WILLUSD",
                    "securitytype": "GDR",
                    "securitytype2": "Depositary Receipt",
                    "shareclassfigi": "BBG01K1ZGP57",
                    "ticker": "WILLUSD"
                },
                "highlight": {
                    "ticker": {
                        "matched_tokens": [
                            "WILL"
                        ],
                        "snippet": "<mark>WILL</mark>USD"
                }
            },
                "highlights": [
                    {
                        "field": "ticker",
                            "matched_tokens": [
                                "WILL"
                            ],
                            "snippet": "<mark>WILL</mark>USD"
                    }
                ],
                "text_match": 578730089005449337
            },
            {
                "document": {
                    "MIC": "ECEU",
                    "compositefigi": "BBG01K4DKF78",
                    "exchcode": "X1",
                    "figi": "BBG01K4DKG30",
                    "id": "575286",
                    "marketsector": "Equity",
                    "name": "WILL SEMICONDUCTOR CO LT-GDR",
                    "name2": "Will Semiconductor Co Lt-Gdr",
                    "securitydescription": "WILLUSD",
                    "securitytype": "GDR",
                    "securitytype2": "Depositary Receipt",
                    "shareclassfigi": "BBG01K1ZGP57",
                    "ticker": "WILLUSD"
                },
                "highlight": {
                    "ticker": {
                        "matched_tokens": [
                            "WILL"
                        ],
                        "snippet": "<mark>WILL</mark>USD"
                }
            },
                "highlights": [
                    {
                        "field": "ticker",
                            "matched_tokens": [
                                "WILL"
                            ],
                            "snippet": "<mark>WILL</mark>USD"
                    }
                ],
                "text_match": 578730089005449337
            },
        ],
        "out_of": 783890,
        "page": 1,
        "request_params": {
        "collection_name": "security_master",
        "per_page": 100,
        "q": "WILL"
    },
        "search_cutoff": false,
        "search_time_ms": 3
    }
}

Authorizations

apikey

string

query

required

Query Parameters

search

string

required

Search query (e.g., ticker)

search_type

enum<string>

required

Type of search (e.g., ticker)

Available options:

ticker,

figi,

share_class_figi,

composite_figi,

exchcode,

MIC

Response

200

application/json

Successful response

error

string | null

Error message if the request fails

message

string

Status message

data

object

Show child attributes

data.facet_counts

string[]

data.found

integer

Total number of matches found

data.hits

object[]

Show child attributes

data.hits.document

object

Show child attributes

data.hits.document.MIC

string

Market Identifier Code

data.hits.document.compositefigi

string

Composite FIGI identifier

data.hits.document.exchcode

string

Exchange code

data.hits.document.figi

string

Financial Instrument Global Identifier

data.hits.document.id

string

Unique identifier

data.hits.document.marketsector

string

Market sector (e.g., Equity)

data.hits.document.name

string

Full name of the security

data.hits.document.name2

string

Alternate name of the security

data.hits.document.securitydescription

string

Description of the security

data.hits.document.securitytype

string

Security type

data.hits.document.securitytype2

string

Additional security type

data.hits.document.shareclassfigi

string

Share class FIGI

data.hits.document.ticker

string

Ticker symbol

data.hits.highlight

object

Show child attributes

data.hits.highlight.ticker

object

Show child attributes

data.hits.highlight.ticker.matched_tokens

string[]

data.hits.highlight.ticker.snippet

string

data.hits.highlights

object[]

Show child attributes

data.hits.highlights.field

string

data.hits.highlights.matched_tokens

string[]

data.hits.highlights.snippet

string

data.hits.text_match

integer

data.out_of

integer

Total number of documents in the collection

data.page

integer

Current page number

data.request_params

object

Show child attributes

data.request_params.collection_name

string

data.request_params.per_page

integer

data.request_params.q

string

data.search_cutoff

boolean

Whether the search reached a cutoff

data.search_time_ms

integer

Time taken for the search in milliseconds