Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Listing APIs
Anchor
listing_apis
listing_apis

This API lists all returns the possible values taken by a query-able fields field in the Global ETF Object. For example, querying the 'sponsor' field will return a list of all sponsors. The Filter API specifies which fields can be queried.

...

Code Block
Request:
GET /api/v1.0/global/filter?field=ExchangeCode&value=XMIL&count=100&offset=0


Response:
{
	"data" : [List of Global ETF objects],
	"status" : true,
	"message" : null
}

Search API

The Search API do does a simple text search on the CompositeTicker, CompositeName and Sponsor fields.

Code Block
Request:
GET /api/v1.0/global/search?kw=sca


Response:
{
  "data": [
    {
      "BloombergSymbol": "SCAP:US",
      "CompositeName": "Cornerstone Small Cap ETF",
      "CompositeTicker": "SCAP",
      "ISIN": "US00768Y5868",
      "Sponsor": "Advisor Shares"
    },
    {
      "BloombergSymbol": "SCAD:LN",
      "CompositeName": "ETFS Short CAD Long USD",
      "CompositeTicker": "SCAD",
      "ISIN": "JE00B68GS291",
      "Sponsor": "ETF Securities"
    }
  ],
  "message": null,
  "status": true
}

If the keyword is less than 3 character search characters, the  search will only function on CompositeTicker, for . For 3 or more character characters, the search will work on CompositeTickers, Sponsor , and CompositeName.