v0.1.0-beta

OpenAPI 3.1.0

Schemas

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

Schemas

contentDirection
Type: string

Content direction if submitted in the request.
data
Type: array object[] ·

Matched creators, sorted by similarityScore descending.
mode
Type: string enum

Search mode resolved by the system.
values
- direction
- homepage
- homepage_direction
platform
Type: string

Platform used for Wave AI matching.
quota
Type: object ·
requestId
Type: string

Request ID for support and monitoring.
seedProfileUrl
Type: string

Seed profile URL if submitted in the request.
sourceUserId
Type: string

Source channel / user ID resolved from seedProfileUrl.
total
Type: number

Number of creators returned after Wave AI matching, filtering, and deduplication.

avatar
Type: string
averageLikeCount
Type: number

TikTok only. YouTube results omit this field.
averagePlayCount
Type: number
channelId
Type: string

YouTube only. Channel ID.
channelTitle
Type: string

YouTube only. Channel display name.
description
Type: string
email
Type: string nullable
followerCount
Type: number
language
Type: string
lastPublishedTime
Type: number
nickname
Type: string

TikTok only. Creator display name.
platform
Type: string
platformHandle
Type: string
profileUrl
Type: string
region
Type: string
similarityScore
Type: number

Wave AI match score (0.7–1.0). Used to rank results.
uniqueId
Type: string

TikTok only. Creator handle without the leading @.
userId
Type: string

TikTok only. Platform-side creator ID.
username
Type: string

chargedQuota
Type: number
consumedQuota
Type: number

Credits consumed to date; mirrors usedQuota.
expiresAt
Type: string nullable

Quota expiry; null when the quota does not expire.
refundQuota
Type: number
refundStatus
Type: string
remainingQuota
Type: number
reservedQuota
Type: number
status
Type: string

Quota status, e.g. active.
totalQuota
Type: number
usedQuota
Type: number

languages
Type: array string[]

Creator languages, e.g. ["en", "ja", "zh-cn"].
maxFollowers
Type: number

Maximum follower / subscriber count.
maxVideosAverageViews
Type: number

Maximum average view / play count.
minFollowers
Type: number

Minimum follower / subscriber count.
minVideosAverageViews
Type: number

Minimum average view / play count.
regions
Type: array string[]

Creator regions, e.g. ["US", "GB", "JP"].

code
Type: integer

Integer numbers.
followers
Type: array object[] ·
has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string nullable
status
Type: string enum
values
- success
- error

automatedBy
Type: string
canDm
Type: boolean
coverPicture
Type: string
createdAt
Type: string
description
Type: string
favouritesCount
Type: integer

Integer numbers.
followers
Type: integer

Integer numbers.
following
Type: integer

Integer numbers.
hasCustomTimelines
Type: boolean
id
Type: string
isAutomated
Type: boolean
isBlueVerified
Type: boolean
isTranslator
Type: boolean
location
Type: string
mediaCount
Type: integer

Integer numbers.
message
Type: string
name
Type: string
pinnedTweetIds
Type: array string[]
possiblySensitive
Type: boolean
profile_bio
Type: object
profilePicture
Type: string
statusesCount
Type: integer

Integer numbers.
type
Type: string
unavailable
Type: boolean
unavailableReason
Type: string
url
Type: string
userName
Type: string
verifiedType
Type: string
withheldInCountries
Type: array string[]

has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string
status
Type: string enum
values
- success
- error
users
Type: array object[] ·

data
Type: object
message
Type: string
status
Type: string enum
values
- success
- error

code
Type: integer

Integer numbers.
has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string
status
Type: string enum
values
- success
- error
tweets
Type: array object[] ·

author
Type: object ·
bookmarkCount
Type: integer

Integer numbers.
conversationId
Type: string
createdAt
Type: string
displayTextRange
Type: array integer[]
entities
Type: object
id
Type: string
inReplyToId
Type: string
inReplyToUserId
Type: string
inReplyToUsername
Type: string
isLimitedReply
Type: boolean
isReply
Type: boolean
lang
Type: string
likeCount
Type: integer

Integer numbers.
quoteCount
Type: integer

Integer numbers.
quoted_tweet
Type: string
replyCount
Type: integer

Integer numbers.
retweetCount
Type: integer

Integer numbers.
retweeted_tweet
Type: string
source
Type: string
text
Type: string
type
Type: string
url
Type: string
viewCount
Type: integer

Integer numbers.

code
Type: integer

Integer numbers.
followings
Type: array object[] ·
has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string
status
Type: string enum
values
- success
- error

code
Type: integer

Integer numbers.
followers
Type: array object[]

Follower user object returned by TwitterAPI.io.
has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string nullable
status
Type: string enum
values
- success
- error

code
Type: integer

Provider status code.
data
Type: object
has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string nullable
status
Type: string enum
values
- success
- error

data
Type: object

User profile object returned by TwitterAPI.io.
msg
Type: string
status
Type: string enum
values
- success
- error

msg
Type: string
status
Type: string enum
values
- success
- error
users
Type: array object[]

data
Type: object
msg
Type: string
status
Type: string enum
values
- success
- error

has_next_page
Type: boolean
next_cursor
Type: string
tweets
Type: array object[] ·

article
Type: object · nullable
msg
Type: string
status
Type: string enum
values
- success
- failed

author
Type: object ·
contents
Type: array object[]
cover_media_img_url
Type: string
createdAt
Type: string
likeCount
Type: integer

Integer numbers.
preview_text
Type: string
quoteCount
Type: integer

Integer numbers.
replyCount
Type: integer

Integer numbers.
title
Type: string
viewCount
Type: integer

Integer numbers.

has_next_page
Type: boolean
msg
Type: string
next_cursor
Type: string
status
Type: string enum
values
- success
- error
tweets
Type: array object[] ·

data
Type: object ·
msg
Type: string
status
Type: string enum
values
- success
- error

created_at
Type: string Format: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
creator
Type: object
id
Type: string
is_subscribed
Type: boolean
media_key
Type: string
scheduled_start
Type: string Format: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
settings
Type: object
state
Type: string
stats
Type: object
title
Type: string
updated_at
Type: string Format: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

msg
Type: string
status
Type: string enum
values
- success
- error
trends
Type: array object[] ·

meta_description
Type: string
name
Type: string
rank
Type: integer Format: int64

Signed 64-bit integers (long type).
target
Type: object

has_next_page
Type: boolean

Indicates if there are more results available
members
Type: array object[] ·
msg
Type: string

Message of the request, error message if status is error
next_cursor
Type: string

Cursor for fetching the next page of results
status
Type: string enum

Status of the request
values
- success
- error

automatedBy
Type: string

Indicates who automated the account
canDm
Type: boolean

Indicates if the user can be direct messaged
coverPicture
Type: string

URL of the cover picture
createdAt
Type: string

Account creation date
description
Type: string

Description of the user
favouritesCount
Type: integer

Number of favorites
followers
Type: integer

Number of followers
following
Type: integer

Number of followings
hasCustomTimelines
Type: boolean

Indicates if the user has custom timelines
id
Type: string

ID of the user
isAutomated
Type: boolean

Indicates if the account is automated
isBlueVerified
Type: boolean

Indicates if the user is blue verified
isTranslator
Type: boolean

Indicates if the user is a translator
location
Type: string

Location of the user
mediaCount
Type: integer

Number of media items
message
Type: string

Message about the account
name
Type: string

Name of the user
pinnedTweetIds
Type: array string[]

List of pinned tweet IDs
possiblySensitive
Type: boolean

Indicates if the user has sensitive content
profile_bio
Type: object
profilePicture
Type: string

URL of the profile picture
statusesCount
Type: integer

Number of statuses
type
Type: string

Type of the user
unavailable
Type: boolean

Indicates if the account is unavailable
unavailableReason
Type: string

Reason for unavailability
url
Type: string

URL of the user's profile
userName
Type: string

Username of the user
verifiedType
Type: string

Type of verification
withheldInCountries
Type: array string[]

List of countries where the user is withheld

display_url
Type: string

Display URL
expanded_url
Type: string

Expanded URL
indices
Type: array integer[]

Indices of the URL
url
Type: string

URL

followers
Type: array object[] ·
has_next_page
Type: boolean

Indicates if there are more results available
msg
Type: string

Message of the request, error message if status is error
next_cursor
Type: string

Cursor for fetching the next page of results
status
Type: string enum

Status of the request
values
- success
- error

has_next_page
Type: boolean

Indicates if there are more results available
msg
Type: string

Message of the request, error message if status is error
next_cursor
Type: string

Cursor for fetching the next page of results
status
Type: string enum

Status of the request
values
- success
- error
tweets
Type: array object[] ·

Array of tweets from the list

community_info
Type: object ·
msg
Type: string
status
Type: string enum
values
- success
- error

admin
Type: object ·
banner_url
Type: string nullable
created_at
Type: string nullable
creator
Type: object ·
description
Type: string nullable
id
Type: string nullable
invites_policy
Type: string nullable
is_nsfw
Type: boolean
is_pinned
Type: boolean
join_policy
Type: string nullable
member_count
Type: integer

Integer numbers.
members_preview
Type: array object[]
Empty object
moderator_count
Type: integer

Integer numbers.
name
Type: string nullable
primary_topic
Type: object
question
Type: string nullable
role
Type: string nullable
rules
Type: array object[]
search_tags
Type: array string[]

SimilarWeb v5 response envelope metadata.

status
Type: string
required

Operation status; success for a successful lookup.
last_updated
Type: string

Date of the most recent available data point (YYYY-MM-DD).
query
Type: object

Pagination/sort echo when applicable (limit, offset, asc, sort).
request
Type: object

Normalized request parameters used for this lookup.

comments
Type: array object[] ·
credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
success
Type: boolean
propertyName
Type: anything

propertyName
Type: anything

after
Type: string nullable
credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
posts
Type: array object[] ·
success
Type: boolean
propertyName
Type: anything

propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
description
Type: string
display_name
Type: string
rules
Type: array object[] | string

Community rules as structured entries or formatted text.
subreddit_id
Type: string
subscribers
Type: integer

Integer numbers.
success
Type: boolean
weekly_active_users
Type: integer

Integer numbers.
weekly_contributions
Type: integer

Integer numbers.
propertyName
Type: anything

error
Type: string

A short error message.
message
Type: string

A more detailed error message.

JSON explanation response returned when response_mode is NON_STREAMING.

message
Type: string
required

Generated explanation text.

search_id
Type: string
required

ID of the search to explain
detail_level
Type: string enum

Level of detail in the explanation
values
- BRIEF
- MODERATE
- DETAILED
language
Type: string

Language code for the explanation (e.g., en, zh, ar)
response_mode
Type: string enum

Format of the explanation response. COMPLETE and INCREMENTAL stream server-sent events; NON_STREAMING returns a JSON response.
values
- COMPLETE
- INCREMENTAL
- NON_STREAMING

id
Type: string
required

Unique identifier for the search request
results
Type: array object[] ·
required

List of academic paper results

authors
Type: array string[]
required

List of authors
link
Type: string Format: uri
required

URL to access the full paper
number_of_citations
Type: integer
min:
0
required

Number of citations the paper has received
snippet
Type: string
required

Brief summary or abstract of the paper
title
Type: string
required

Title of the academic paper
journal
Type: string

Journal or conference name
year
Type: integer
min:
1900
max:
2030

Publication year

id
Type: string
required

Unique identifier for the search request
results
Type: array object[] ·
required

List of web search results

link
Type: string Format: uri
required

URL to access the web page
snippet
Type: string
required

Brief summary or preview of the web page content
title
Type: string
required

Title of the web page
display_url
Type: string

Display-friendly URL
published_date
Type: string Format: date-time

Publication date of the web page

id
Type: string
required

Unique identifier for the search request
results
Type: array object[] ·
required

List of smart search results combining web and academic content
search_type
Type: string enum

Type of search results included
values
- web
- academic
- hybrid

link
Type: string Format: uri
required

URL to access the content
snippet
Type: string
required

Brief summary or abstract
title
Type: string
required

Title of the result
authors
Type: array string[]

List of authors (for academic content)
number_of_citations
Type: integer
min:
0

Number of citations (for academic content)
relevance_score
Type: number
min:
0
max:
1

Relevance score of the result
type
Type: string enum

Type of the result
values
- web
- academic

boards
Type: array object[]
credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
pins
Type: array object[]
success
Type: boolean
propertyName
Type: anything

createdAt
Type: string
credits_remaining
Type: integer

Integer numbers.
description
Type: string
entityId
Type: string
originPinner
Type: object nullable
pinner
Type: object
repinCount
Type: integer

Integer numbers.
success
Type: boolean
totalReactionCount
Type: integer

Integer numbers.
propertyName
Type: anything

earnings
Type: object ·

annual
Type: object ·
currency
Type: string nullable

ISO currency code (e.g. USD).
fiscal_period
Type: string nullable

Fiscal period label (e.g. 2025-Q4 or 2025-FY).
quarterly
Type: object ·
report_period
Type: string Format: date

Most recent report period found for the ticker.
ticker
Type: string

The requested ticker symbol.

capital_expenditure
Type: number nullable
cash_and_equivalents
Type: number nullable
change_in_cash_and_equivalents
Type: number nullable
currency
Type: string nullable

ISO currency code (e.g. USD).
earnings_per_share
Type: number nullable
eps_surprise
Type: string enum

EPS surprise classification versus estimate. Returned only when available.
values
- BEAT
- MISS
- MEET
estimated_earnings_per_share
Type: number

Estimated earnings per share. Returned only when available.
estimated_revenue
Type: number

Estimated revenue. Returned only when available.
fiscal_period
Type: string nullable

Fiscal period label (e.g. 2025-Q4 or 2025-FY).
free_cash_flow
Type: number nullable
free_cash_flow_chg
Type: number

Percentage change in free cash flow. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
gross_profit
Type: number nullable
gross_profit_chg
Type: number

Percentage change in gross profit. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_cash_flow_from_financing
Type: number nullable
net_cash_flow_from_financing_chg
Type: number

Percentage change in net cash flow from financing. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_cash_flow_from_investing
Type: number nullable
net_cash_flow_from_investing_chg
Type: number

Percentage change in net cash flow from investing. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_cash_flow_from_operations
Type: number nullable
net_cash_flow_from_operations_chg
Type: number

Percentage change in net cash flow from operations. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_income
Type: number nullable
net_income_chg
Type: number

Percentage change in net income. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
operating_income
Type: number nullable
operating_income_chg
Type: number

Percentage change in operating income. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
revenue
Type: number nullable
revenue_chg
Type: number

Percentage change in revenue. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
revenue_surprise
Type: string enum

Revenue surprise classification versus estimate. Returned only when available.
values
- BEAT
- MISS
- MEET
shareholders_equity
Type: number nullable
total_assets
Type: number nullable
total_debt
Type: number nullable
total_liabilities
Type: number nullable
weighted_average_shares
Type: number nullable
weighted_average_shares_diluted
Type: number nullable

results
Type: array object[]

Stocks matching the requested screener filters.

filters
Type: array object[] 1…
required

An array of filter objects to apply to the search.
currency
Type: string enum

The currency of the financial data.
values
- USD
- EUR
- GBP
- JPY
- CHF
- AUD
- CAD
- SEK
historical
Type: boolean

Whether to return historical financial data.
limit
Type: integer
min:
1
max:
100

The maximum number of results to return.
order_by
Type: string enum

The field to order the results by. Use -field to order in descending order.
values
- ticker
- -ticker
- report_period
- -report_period
period
Type: string enum

The time period for the financial data.
values
- annual
- quarterly
- ttm

snapshot
Type: object ·

asset_turnover
Type: number nullable

Revenue divided by average total assets.
book_value_growth
Type: number nullable

Year-over-year growth in book value.
book_value_per_share
Type: number nullable

Shareholders' equity divided by shares outstanding.
cash_ratio
Type: number nullable

Cash and cash equivalents divided by current liabilities.
current_ratio
Type: number nullable

Current assets divided by current liabilities.
days_sales_outstanding
Type: number nullable

Average accounts receivable divided by revenue over the period.
debt_to_assets
Type: number nullable

Total debt divided by total assets.
debt_to_equity
Type: number nullable

Total debt divided by shareholders' equity.
earnings_growth
Type: number nullable

Year-over-year growth in earnings.
earnings_per_share
Type: number nullable

Net income divided by weighted average shares outstanding.
earnings_per_share_growth
Type: number nullable

Growth in earnings per share over the period.
ebitda_growth
Type: number nullable

Growth in EBITDA over the period.
enterprise_value
Type: number nullable

The total value of the company (market cap + debt - cash).
enterprise_value_to_ebitda_ratio
Type: number nullable

Enterprise value to EBITDA ratio.
enterprise_value_to_revenue_ratio
Type: number nullable

Enterprise value to revenue ratio.
free_cash_flow_growth
Type: number nullable

Growth in free cash flow over the period.
free_cash_flow_per_share
Type: number nullable

Free cash flow divided by shares outstanding.
free_cash_flow_yield
Type: number nullable

Free cash flow yield.
gross_margin
Type: number nullable

Gross profit as a percentage of revenue.
interest_coverage
Type: number nullable

EBIT divided by interest expense.
inventory_turnover
Type: number nullable

Cost of goods sold divided by average inventory.
market_cap
Type: number nullable

The total market capitalization (stock price × shares outstanding).
net_margin
Type: number nullable

Net income as a percentage of revenue.
operating_cash_flow_ratio
Type: number nullable

Operating cash flow divided by current liabilities.
operating_cycle
Type: number nullable

Inventory turnover + receivables turnover.
operating_income_growth
Type: number nullable

Growth in operating income over the period.
operating_margin
Type: number nullable

Operating income as a percentage of revenue.
payout_ratio
Type: number nullable

Dividends paid as a percentage of net income.
peg_ratio
Type: number nullable

Price to earnings growth ratio.
price_to_book_ratio
Type: number nullable

Price to book ratio.
price_to_earnings_ratio
Type: number nullable

Price to earnings ratio.
price_to_sales_ratio
Type: number nullable

Price to sales ratio.
quick_ratio
Type: number nullable

Quick assets divided by current liabilities.
receivables_turnover
Type: number nullable

Revenue divided by average accounts receivable.
return_on_assets
Type: number nullable

Net income as a percentage of total assets.
return_on_equity
Type: number nullable

Net income as a percentage of shareholders' equity.
return_on_invested_capital
Type: number nullable

Net operating profit after taxes as a percentage of invested capital.
revenue_growth
Type: number nullable

Year-over-year growth in revenue.
ticker
Type: string

The ticker symbol of the company.
working_capital_turnover
Type: number nullable

Revenue divided by average working capital.

financial_metrics
Type: array object[] ·

Historical financial metrics and ratios for the requested ticker.

asset_turnover
Type: number

Revenue divided by average total assets.
book_value_growth
Type: number

Year-over-year growth in book value.
book_value_per_share
Type: number

Shareholders' equity divided by shares outstanding.
cash_ratio
Type: number

Cash and cash equivalents divided by current liabilities.
current_ratio
Type: number

Current assets divided by current liabilities.
days_sales_outstanding
Type: number

Average accounts receivable divided by revenue over the period.
debt_to_assets
Type: number

Total debt divided by total assets.
debt_to_equity
Type: number

Total debt divided by shareholders' equity.
earnings_growth
Type: number

Year-over-year growth in earnings.
earnings_per_share
Type: number

Net income divided by weighted average shares outstanding.
earnings_per_share_growth
Type: number

Growth in earnings per share over the period.
ebitda_growth
Type: number

Growth in EBITDA over the period.
enterprise_value
Type: number

The total value of the company (market cap + debt - cash).
enterprise_value_to_ebitda_ratio
Type: number

Enterprise value to EBITDA ratio.
enterprise_value_to_revenue_ratio
Type: number

Enterprise value to revenue ratio.
free_cash_flow_growth
Type: number

Growth in free cash flow over the period.
free_cash_flow_per_share
Type: number

Free cash flow divided by shares outstanding.
free_cash_flow_yield
Type: number

Free cash flow yield.
gross_margin
Type: number

Gross profit as a percentage of revenue.
interest_coverage
Type: number

EBIT divided by interest expense.
inventory_turnover
Type: number

Cost of goods sold divided by average inventory.
market_cap
Type: number

The market capitalization of the company.
net_margin
Type: number

Net income as a percentage of revenue.
operating_cash_flow_ratio
Type: number

Operating cash flow divided by current liabilities.
operating_cycle
Type: number

Inventory turnover + receivables turnover.
operating_income_growth
Type: number

Growth in operating income over the period.
operating_margin
Type: number

Operating income as a percentage of revenue.
payout_ratio
Type: number

Dividends paid as a percentage of net income.
peg_ratio
Type: number

Price to earnings growth ratio.
price_to_book_ratio
Type: number

Price to book ratio.
price_to_earnings_ratio
Type: number

Price to earnings ratio.
price_to_sales_ratio
Type: number

Price to sales ratio.
quick_ratio
Type: number

Quick assets divided by current liabilities.
receivables_turnover
Type: number

Revenue divided by average accounts receivable.
return_on_assets
Type: number

Net income as a percentage of total assets.
return_on_equity
Type: number

Net income as a percentage of shareholders' equity.
return_on_invested_capital
Type: number

Net operating profit after taxes as a percentage of invested capital.
revenue_growth
Type: number

Year-over-year growth in revenue.
ticker
Type: string

The ticker symbol of the company.
working_capital_turnover
Type: number

Revenue divided by average working capital.

next_page_url
Type: string

The URL to the next page of results.
prices
Type: array object[] ·

close
Type: number

The close price of the ticker in the given time period.
high
Type: number

The high price of the ticker in the given time period.
low
Type: number

The low price of the ticker in the given time period.
open
Type: number

The open price of the ticker in the given time period.
time
Type: string

The human-readable time format of the price in UTC.
time_milliseconds
Type: number

The timestamp of the price in milliseconds since epoch.
volume
Type: integer Format: number

The volume of the ticker in the given time period.

news
Type: array object[] ·

author
Type: string

The author of the news article.
date
Type: string Format: date

The date the news article was published.
sentiment
Type: string

The sentiment of the news article.
source
Type: string

The source of the news article.
ticker
Type: string

The ticker symbol.
title
Type: string

The title of the news article.
url
Type: string Format: uri

The URL of the news article.

financials
Type: object

consolidated_income
Type: number

The consolidated income of the company.
cost_of_revenue
Type: number

The cost of revenue of the company.
currency
Type: string

The currency in which the financial data is reported.
dividends_per_common_share
Type: number

The dividends per common share of the company.
earnings_per_share
Type: number

The earnings per share of the company.
earnings_per_share_diluted
Type: number

The diluted earnings per share of the company.
ebit
Type: number

The earnings before interest and taxes of the company.
fiscal_period
Type: string

The fiscal period of the income statement.
gross_profit
Type: number

The gross profit of the company.
income_tax_expense
Type: number

The income tax expenses of the company.
interest_expense
Type: number

The interest expenses of the company.
net_income
Type: number

The net income of the company.
net_income_common_stock
Type: number

The net income available to common stockholders of the company.
net_income_discontinued_operations
Type: number

The net income from discontinued operations of the company.
net_income_non_controlling_interests
Type: number

The net income from non-controlling interests of the company.
operating_expense
Type: number

The operating expenses of the company.
operating_income
Type: number

The operating income of the company.
period
Type: string enum

The time period of the income statement.
values
- quarterly
- ttm
- annual
preferred_dividends_impact
Type: number

The impact of preferred dividends on the net income of the company.
report_period
Type: string Format: date

The reporting period of the income statement.
research_and_development
Type: number

The research and development expenses of the company.
revenue
Type: number

The total revenue of the company.
selling_general_and_administrative_expenses
Type: number

The selling, general, and administrative expenses of the company.
ticker
Type: string

The ticker symbol.
weighted_average_shares
Type: number

The weighted average shares of the company.
weighted_average_shares_diluted
Type: number

The diluted weighted average shares of the company.

accumulated_other_comprehensive_income
Type: number

The accumulated other comprehensive income of the company.
cash_and_equivalents
Type: number

The cash and equivalents of the company.
currency
Type: string

The currency in which the financial data is reported.
current_assets
Type: number

The current assets of the company.
current_debt
Type: number

The current debt of the company.
current_investments
Type: number

The current investments of the company.
current_liabilities
Type: number

The current liabilities of the company.
deferred_revenue
Type: number

The deferred revenue of the company.
deposit_liabilities
Type: number

The deposit liabilities of the company.
fiscal_period
Type: string

The fiscal period of the balance sheet.
goodwill_and_intangible_assets
Type: number

The goodwill and intangible assets of the company.
inventory
Type: number

The inventory of the company.
investments
Type: number

The investments of the company.
non_current_assets
Type: number

The non-current assets of the company.
non_current_debt
Type: number

The non-current debt of the company.
non_current_investments
Type: number

The non-current investments of the company.
non_current_liabilities
Type: number

The non-current liabilities of the company.
outstanding_shares
Type: number

The outstanding shares of the company.
period
Type: string enum

The time period of the balance sheet.
values
- quarterly
- ttm
- annual
property_plant_and_equipment
Type: number

The property, plant, and equipment of the company.
report_period
Type: string Format: date

The reporting period of the balance sheet.
retained_earnings
Type: number

The retained earnings of the company.
shareholders_equity
Type: number

The shareholders' equity of the company.
tax_assets
Type: number

The tax assets of the company.
tax_liabilities
Type: number

The tax liabilities of the company.
ticker
Type: string

The ticker symbol.
total_assets
Type: number

The total assets of the company.
total_debt
Type: number

The total debt of the company.
total_liabilities
Type: number

The total liabilities of the company.
trade_and_non_trade_payables
Type: number

The trade and non-trade payables of the company.
trade_and_non_trade_receivables
Type: number

The trade and non-trade receivables of the company.

business_acquisitions_and_disposals
Type: number

The business acquisitions and disposals of the company.
capital_expenditure
Type: number

The capital expenditure of the company.
change_in_cash_and_equivalents
Type: number

The change in cash and equivalents of the company.
currency
Type: string

The currency in which the financial data is reported.
depreciation_and_amortization
Type: number

The depreciation and amortization of the company.
dividends_and_other_cash_distributions
Type: number

The dividends and other cash distributions of the company.
effect_of_exchange_rate_changes
Type: number

The effect of exchange rate changes of the company.
ending_cash_balance
Type: number

The ending cash balance of the company.
fiscal_period
Type: string

The fiscal period of the cash flow statement.
free_cash_flow
Type: number

The free cash flow of the company.
investment_acquisitions_and_disposals
Type: number

The investment acquisitions and disposals of the company.
issuance_or_purchase_of_equity_shares
Type: number

The issuance or purchase of equity shares of the company.
issuance_or_repayment_of_debt_securities
Type: number

The issuance or repayment of debt securities of the company.
net_cash_flow_from_financing
Type: number

The net cash flow from financing of the company.
net_cash_flow_from_investing
Type: number

The net cash flow from investing of the company.
net_cash_flow_from_operations
Type: number

The net cash flow from operations of the company.
net_income
Type: number

The net income of the company.
period
Type: string enum

The time period of the cash flow statement.
values
- quarterly
- ttm
- annual
report_period
Type: string Format: date

The reporting period of the cash flow statement.
share_based_compensation
Type: number

The share-based compensation of the company.
ticker
Type: string

The ticker symbol.

snapshot
Type: object ·

day_change
Type: number

The price change since the previous trading day's close.
day_change_percent
Type: number

The percentage price change since the previous trading day's close.
market_cap
Type: number

The market capitalization of the company.
price
Type: number

The current price of the stock.
ticker
Type: string

The ticker symbol.
time
Type: string

The timestamp of the price snapshot in human-readable format in UTC.
time_milliseconds
Type: number

The timestamp of the price snapshot in milliseconds since epoch.

cash_flow_statements
Type: array object[] ·

balance_sheets
Type: array object[] ·

income_statements
Type: array object[] ·

accession_number
Type: string

The accession number of the filing.
cik
Type: string

The Central Index Key (CIK) of the company.
filing_type
Type: string

The type of filing.
items
Type: array object[] ·
quarter
Type: integer

The quarter of the filing.
ticker
Type: string

The ticker symbol of the company.
year
Type: integer

The year of the filing.

name
Type: string

The item name.
number
Type: string

The item number.
text
Type: string

The item text.

filings
Type: array object[] ·

accession_number
Type: string

The accession number of the filing.
cik
Type: integer

The Central Index Key (CIK) of the company.
filing_type
Type: string

The type of the SEC filing (e.g., 10-Q, 8-K).
report_date
Type: string Format: date

The date of the report.
ticker
Type: string

The ticker symbol.
url
Type: string Format: uri

The URL of the SEC filing.

company_facts
Type: object ·

category
Type: string

The category of the company.
cik
Type: string

The Central Index Key (CIK) of the company.
exchange
Type: string

The exchange of the company.
industry
Type: string

The industry of the company.
is_active
Type: boolean

Whether the company is currently active.
listing_date
Type: string Format: date

The date the company was listed on the stock exchange.
location
Type: string

The location of the company.
market_cap
Type: number

The market capitalization of the company.
name
Type: string

The name of the company.
number_of_employees
Type: number

The number of employees at the company.
sec_filings_url
Type: string Format: uri

The URL of the company's SEC filings.
sector
Type: string

The sector of the company.
sic_code
Type: string

The Standard Industrial Classification (SIC) code of the company.
sic_industry
Type: string

The industry of the company based on the SIC code.
sic_sector
Type: string

The sector of the company based on the SIC code.
ticker
Type: string

The ticker symbol of the company.
website_url
Type: string Format: uri

The URL of the company's website.
weighted_average_shares
Type: number

The weighted average shares of the company.

insider_trades
Type: array object[] ·

filing_date
Type: string Format: date

The date the transaction was filed.
is_board_director
Type: boolean

Whether the insider is a board director.
issuer
Type: string

The name of the issuing company.
name
Type: string

The name of the insider.
security_title
Type: string

The title of the security involved in the transaction.
shares_owned_after_transaction
Type: number

The number of shares owned after the transaction.
shares_owned_before_transaction
Type: number

The number of shares owned before the transaction.
ticker
Type: string

The ticker symbol of the company.
title
Type: string

The title of the insider.
transaction_date
Type: string Format: date

The date of the transaction.
transaction_price_per_share
Type: number

The price per share in the transaction.
transaction_shares
Type: number

The number of shares involved in the transaction.
transaction_value
Type: number

The total value of the transaction.

search_results
Type: array object[]

line_items
Type: array string[] 1…
required

An array of line items to apply to the search.
tickers
Type: array string[] 1…
required

An array of tickers to apply to the search.
limit
Type: integer
min:
1

The maximum number of results to return.
period
Type: string enum

The time period for the financial data.
values
- annual
- quarterly
- ttm

interest_rates
Type: array object[] ·

bank
Type: string

The symbol of the central bank.
date
Type: string

The date of the interest rate in YYYY-MM-DD format.
name
Type: string

The name of the central bank.
rate
Type: number

The interest rate of the central bank.

credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
reels
Type: array object[]
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
profiles
Type: array object[]
query
Type: string
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
hashtag
Type: string
media_type
Type: string
posts
Type: array object[]
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
success
Type: boolean
transcripts
Type: array object[]
propertyName
Type: anything

comments
Type: array object[]
credits_remaining
Type: integer

Integer numbers.
cursor
Type: string nullable
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
success
Type: boolean
xdt_shortcode_media
Type: object
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
html
Type: string
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
id
Type: string
items
Type: array object[]
reel_type
Type: string
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
highlights
Type: array object[]
success
Type: boolean
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
items
Type: array object[]
max_id
Type: string nullable
next_max_id
Type: string nullable
success
Type: boolean
propertyName
Type: anything

biography
Type: string
credits_remaining
Type: integer

Integer numbers.
follower_count
Type: integer

Integer numbers.
following_count
Type: integer

Integer numbers.
full_name
Type: string
id
Type: string
is_private
Type: boolean
is_verified
Type: boolean
media_count
Type: integer

Integer numbers.
pk
Type: string
success
Type: boolean
username
Type: string
propertyName
Type: anything

credits_remaining
Type: integer

Integer numbers.
data
Type: object
success
Type: boolean
propertyName
Type: anything

An asynchronous integration job. Returned by the submit call (HTTP 202) and by the poll/detail call. Poll the job by its id until status is a terminal value (completed, failed, or cancelled).

completedAt
Type: string Format: date-timenullable

When the job reached a terminal status. Null while the job is still queued or running.
createdAt
Type: string Format: date-time

When the job was accepted.
endpoint
Type: string

Provider operation identifier stored with the job. This metadata is not a Felo polling URL; use the documented Felo job path or Location header.
error
Type: object nullable

Present when status is failed. Null otherwise.
id
Type: string

Job identifier. Use it with the corresponding Felo polling endpoint.
object
Type: string

Always "integration_async_job".
output
nullable

Job result payload. Present only once status is completed. For Agent Runs this is the structured research result.
outputExpired
Type: boolean

True when the result has been retained past its retention window and is no longer retrievable.
pricing
Type: object
status
Type: string enum

Customer-facing lifecycle status. queued and running are non-terminal; completed, failed, and cancelled are terminal.
values
- queued
- running
- completed
- failed
- cancelled

market_caps
Type: array array number[][]
prices
Type: array array number[][]
total_volumes
Type: array array number[][]
propertyName
Type: anything

error
Type: object
status
Type: object
propertyName
Type: anything

Type: object ·

additional_notices
Type: array string[]

additional notices
asset_platform_id
Type: string

coin asset platform ID
block_time_in_minutes
Type: number

blockchain block time in minutes
categories
Type: array string[]

coin categories
community_data
Type: object

coin community data
contract_address
Type: string

coin contract address
country_origin
Type: string

coin country of origin
description
Type: object

coin description
detail_platforms
Type: object

detailed coin asset platform and contract address
developer_data
Type: object

coin developer data
genesis_date
Type: string Format: date-timenullable

coin genesis date
hashing_algorithm
Type: string nullable

blockchain hashing algorithm
id
Type: string

coin ID
image
Type: object

coin image url
last_updated
Type: string Format: date-time

coin last updated timestamp
links
Type: object

links
localization
Type: object

coin name localization
market_cap_rank
Type: number

coin rank by market cap
market_cap_rank_with_rehypothecated
Type: number

coin rank by market cap including rehypothecated tokens
market_data
Type: object

coin market data
name
Type: string

coin name
platforms
Type: object

coin asset platform and contract address
preview_listing
Type: boolean

preview listing coin
public_notice
Type: string nullable

public notice
sentiment_votes_down_percentage
Type: number

coin sentiment votes down percentage
sentiment_votes_up_percentage
Type: number

coin sentiment votes up percentage
status_updates
Type: array string[]

coin status updates
symbol
Type: string

coin symbol
tickers
Type: array object[]

coin tickers
watchlist_portfolio_users
Type: number

number of users watching this coin in portfolio
web_slug
Type: string

coin web slug

propertyName
Type: object
- propertyName
  Type: anything

name
Type: string
tickers
Type: array object[]
propertyName
Type: anything

Type: array object[]

Type: array object[]

propertyName
Type: anything

Type: array array number[][]

Type: array string[]

analyst_estimates
Type: array object[] ·

earnings_per_share
Type: number

The estimated earnings per share.
fiscal_period
Type: string Format: date

The fiscal period of the analyst estimate.
period
Type: string enum

The period of the analyst estimate.
values
- annual
- quarterly
revenue
Type: integer

The estimated revenue.

choices
Type: array object[]
citations
Type: array string[]

List of source URLs referenced in the answer.
created
Type: integer

Unix timestamp of when the completion was created.
id
Type: string

Unique identifier for the completion.
model
Type: string

The model used for the completion.
object
Type: string
search_results
Type: array object[]

Detailed search results with titles, snippets, and URLs.
usage
Type: object

messages
Type: array object[]
required

A list of messages comprising the conversation so far.
model
Type: string enum
required

The Sonar model to use.
values
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Type: number
min:
0
max:
2

Penalizes new tokens based on their existing frequency in the text so far. Positive values decrease the likelihood of repeating the same line verbatim.
max_tokens
Type: integer

The maximum number of tokens to generate in the response.
presence_penalty
Type: number
min:
-2
max:
2

Penalizes new tokens based on whether they appear in the text so far. Positive values increase the likelihood of talking about new topics.
return_citations
Type: boolean

Whether to return citations and search results in the response.
search_context
Type: string enum

Controls how much search context to use. Affects per-request cost.
values
- low
- medium
- high
search_domain_filter
Type: array string[]

Limit search to specific domains.
search_recency_filter
Type: string enum

Filter search results by recency.
values
- month
- week
- day
- hour
stream
Type: boolean enum
const:
false

Only non-streaming JSON responses are covered by this public contract. Set false.
values
- false
temperature
Type: number
min:
0
max:
2

Sampling temperature between 0 and 2. Lower values make output more focused and deterministic.
top_k
Type: integer
min:
0
max:
2048

The number of tokens to keep for top-k filtering.
top_p
Type: number
min:
0
max:
1

Nucleus sampling parameter. The model considers tokens with top_p probability mass.

contacts
Type: array object[]

External contact links identified during the lookup.
email
Type: string nullable

Primary email address; null if not found.
emails
Type: array string[]

All unique emails found in this lookup.
platform
Type: string

Platform parsed from the profile URL: tiktok, instagram, or youtube.
platformUserId
Type: string nullable

Platform-side creator ID, if available.
profileLink
Type: string

Normalized profile URL used for this request.
quota
Type: object ·
region
Type: string nullable

Creator region, if available.
username
Type: string nullable

Creator username returned by the lookup chain.

cost
Type: number

Resource units consumed by this lookup. This is not a USD amount or a Felo credit charge.
remainingQuota
Type: number

Additional resource quota information. This is not your Felo account balance.

Schemas

Schemas

{} SimilarData

{} SimilarCreator

{} SimilarQuota

{} SimilarCreatorFilters

{} VerifiedFollowersResponse

{} User

{} SearchUserResponse

{} FollowRelationshipResponse

{} UserMentionsResponse

{} Tweet

{} UserFollowingsResponse

{} UserFollowersResponse

{} UserTweetsResponse

{} UserInfoResponse

{} BatchUserInfoResponse

{} UserProfileAboutResponse

{} AdvancedSearchResponse

{} ArticleResponse

{} Article

{} TweetThreadContextResponse

{} SpaceDetailResponse

{} SpaceDetail

{} TrendsResponse

{} Trend

{} TwitterListMembersResponse

{} TwitterUser

{} TwitterUrl

{} TwitterListFollowersResponse

{} ListTweetsTimelineResponse

{} CommunityInfoResponse

{} CommunityInfo

{} SimilarWebMeta

{} RedditCommentsResponse

{} RedditComment

{} RedditPostsResponse

{} RedditPost

{} RedditSubredditDetailsResponse

{} ErrorResponse

{} ExplainSearchResponse

{} ExplainSearchRequest

{} ScholarSearchResponse

{} ScholarResult

{} WebSearchResponse

{} WebResult

{} SmartSearchResponse

{} SmartResult

{} PinterestBoardsResponse

{} PinterestPinsResponse

{} PinterestPinResponse

{} EarningsResponse

{} Earnings

{} EarningsTimeDimension

{} FinancialsScreenerResponse

{} SearchFiltersRequest

{} FinancialMetricSnapshotResponse

{} FinancialMetricSnapshot

{} FinancialMetricsResponse

{} FinancialMetric

{} PricesResponse

{} Price

{} NewsResponse

{} News

{} FinancialsResponse

{} IncomeStatement

{} BalanceSheet

{} CashFlowStatement

{} PriceSnapshotResponse

{} PriceSnapshot

{} CashFlowStatementResponse

{} BalanceSheetResponse

{} IncomeStatementResponse

{} FilingItemsResponse

{} FilingItem

{} FilingsResponse

{} Filing

{} CompanyFactsResponse

{} CompanyFacts

{} InsiderTradesResponse