Skip to main content
GET
/
v1
/
instruments
Get a list of instruments.
curl --request GET \
  --url 'https://api.capyfin.com/v1/instruments?apikey='
{
  "total": 100,
  "sub": true,
  "items": [
    {
      "slug": "nasdaq-aapl",
      "symbol": "AAPL",
      "name": "Apple",
      "type": "stock",
      "exchange": "nasdaq",
      "listed": true,
      "image": "https://example.com/aapl.png",
      "closingPrice": 237.33,
      "returnLastDay": 1.92,
      "returnThisWeek": 3.24,
      "returnThisMonth": 5.06,
      "returnYearToDate": 23.26,
      "returnLastYear": 24.91
    }
  ]
}

Authorizations

​
apikey
string
query
required

Pass your API key as a query parameter (e.g., /endpoint?apikey=YOUR_API_KEY)

Query Parameters

​
name
string
​
symbol
string

Filter by symbol. Accepts multiple symbols separated by commas.

​
type
string
required
​
sector
string
required
​
industry
string
required
​
index
enum<string>

Filter by index. Accepts multiple indices separated by commas.

Available options:
SPX500,
DJ30,
NSDQ100
​
country
string

Filter by country (ISO 3166-1 alpha-2 country code). Accepts multiple countries separated by commas.

Example:

"US,GB"

​
orderBy
string

Sorts results by a field or aggregate expressions. Format for field sort: 'fieldName:order' (e.g., 'returnYearToDate:asc', default is 'desc'). For aggregates like sum or avg, use 'operation(field1,field2):order' (e.g., 'sum(yearlyReturns.2023,yearlyReturns.2022)' or 'avg(operatingMargin,grossIncomeMargin):asc')').

​
fields
string

Comma-separated list of fields to include in the response.

​
page
number

Page number for pagination (default: 1).

Example:

1

​
5YearAverageNetProfitMargin
string

Filter by average net profit margin. Comparators: gt, lt, gte, lte.

Example:

"gt:20"

​
5YearAverageReturnOnInvestedCapital
string

Filter by the average return on investment. Comparators: gt, lt, gte, lte.

Example:

"gt:15"

​
grossIncomeMargin
string

Filter by gross income margin. Comparators: gt, lt, gte, lte.

Example:

"gte:40"

​
operatingMargin
string

Filter by operating margin. Comparators: gt, lt, gte, lte.

Example:

"gte:15"

​
quickRatio
string

Filter by quick ratio. Comparators: gt, lt, gte, lte.

Example:

"gte:1.5"

​
totalDebtToEquityRatio
string

Filter by total debt to equity ratio. Comparators: gt, lt, gte, lte.

Example:

"lt:0.5"

​
beta
string

Filter by beta. Comparators: gt, lt, gte, lte.

Example:

"gt:1"

​
currentRatio
string

Filter by current ratio. Comparators: gt, lt, gte, lte.

Example:

"gte:1"

​
peRatio
string

Filter by P/E ratio. Comparators: gt, lt, gte, lte.

Example:

"lte:25"

​
dividendYield
string

Filter by dividend yield percentage. Comparators: gt, lt, gte, lte.

Example:

"gt:5"

​
salesOrRevenue
string

Filter by sales or revenue in dollars. Comparators: gt, lt, gte, lte.

Example:

"gt:1000000"

​
eps
string

Filter by earnings per share. Comparators: gt, lt, gte, lte.

Example:

"gt:1"

​
marketCapitalization
string

Filter by market cap in dollars. Comparators: gt, lt, gte, lte.

Example:

"gte:100000000"

​
numberOfEmployees
string

Filter by number of employees. Comparators: gt, lt, gte, lte.

Example:

"gte:1000"

Response

200 - application/json
​
total
number
required

The total number of results

Example:

100

​
sub
boolean

Whether this response includes subscriber-only data

Example:

true

​
items
object[]