Search Instruments

GET

Search Instruments

Search or retrieve instrument data, including fundamental data.

Resource URL

https://api.tdameritrade.com/v1 /instruments

Query Parameters

Name Values Description
apikey

Pass your OAuth User ID to make an unauthenticated request for delayed data.

symbol
(required)

Value to pass to the search. See projection description for more information.

projection
(required)

'The type of request:

symbol-search: Retrieve instrument data of a specific symbol or cusip

symbol-regex: Retrieve instrument data for all symbols matching regex. Example: symbol=XYZ.* will return all symbols beginning with XYZ

desc-search: Retrieve instrument data for instruments whose description contains the word supplied. Example: symbol=FakeCompany will return all instruments with FakeCompany in the description.

desc-regex: Search description with full regex support. Example: symbol=XYZ.[A-C] returns all instruments whose descriptions contain a word beginning with XYZ followed by a character A through C.

fundamental: Returns fundamental data for a single instrument specified by exact symbol.'

Header Parameters

Name Values Description
Authorization

Supply an access token to make an authenticated request. The format is Bearer <access token>.

Try it out !!

HTTP Basic

OAuth 2.0

API Key

RESET

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Category

Instruments

Response Summary

Resource Error Codes

HTTP Code

Description

400

An error message indicating the caller must pass a non null value in the parameter.

401

Unauthorized

403

Forbidden

404

An error message indicating the instrument for the symbol/cusip was not found.

406

An error message indicating an issue in the symbol regex, or number of symbols searched is over the maximum.

Working...