v0.1.0-beta

OpenAPI 3.1.0

Schemas

Felo API Support

MIT

サーバー

https://openapi.felo.ai

クライアントライブラリ

Shell Curl

Schemas

contentDirection
型: string

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

Matched creators, sorted by similarityScore descending.
mode
型: string 列挙値

Search mode resolved by the system.
値
- direction
- homepage
- homepage_direction
platform
型: string

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

Request ID for support and monitoring.
seedProfileUrl
型: string

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

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

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

avatar
型: string
averageLikeCount
型: number

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

YouTube only. Channel ID.
channelTitle
型: string

YouTube only. Channel display name.
description
型: string
email
型: string null 許容
followerCount
型: number
language
型: string
lastPublishedTime
型: number
nickname
型: string

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

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

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

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

chargedQuota
型: number
consumedQuota
型: number

Credits consumed to date; mirrors usedQuota.
expiresAt
型: string null 許容

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

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

languages
型: array string[]

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

Maximum follower / subscriber count.
maxVideosAverageViews
型: number

Maximum average view / play count.
minFollowers
型: number

Minimum follower / subscriber count.
minVideosAverageViews
型: number

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

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

code
型: integer

Integer numbers.
followers
型: array object[] ·
has_next_page
型: boolean
msg
型: string
next_cursor
型: string null 許容
status
型: string 列挙値
値
- success
- error

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

Integer numbers.
followers
型: integer

Integer numbers.
following
型: integer

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

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

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

has_next_page
型: boolean
msg
型: string
next_cursor
型: string
status
型: string 列挙値
値
- success
- error
users
型: array object[] ·

data
型: object
message
型: string
status
型: string 列挙値
値
- success
- error

code
型: integer

Integer numbers.
has_next_page
型: boolean
msg
型: string
next_cursor
型: string
status
型: string 列挙値
値
- success
- error
tweets
型: array object[] ·

author
型: object ·
bookmarkCount
型: integer

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

Integer numbers.
quoteCount
型: integer

Integer numbers.
quoted_tweet
型: string
replyCount
型: integer

Integer numbers.
retweetCount
型: integer

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

Integer numbers.

code
型: integer

Integer numbers.
followings
型: array object[] ·
has_next_page
型: boolean
msg
型: string
next_cursor
型: string
status
型: string 列挙値
値
- success
- error

code
型: integer

Integer numbers.
followers
型: array object[]

Follower user object returned by TwitterAPI.io.
has_next_page
型: boolean
msg
型: string
next_cursor
型: string null 許容
status
型: string 列挙値
値
- success
- error

code
型: integer

Provider status code.
data
型: object
has_next_page
型: boolean
msg
型: string
next_cursor
型: string null 許容
status
型: string 列挙値
値
- success
- error

data
型: object

User profile object returned by TwitterAPI.io.
msg
型: string
status
型: string 列挙値
値
- success
- error

msg
型: string
status
型: string 列挙値
値
- success
- error
users
型: array object[]

data
型: object
msg
型: string
status
型: string 列挙値
値
- success
- error

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

article
型: object · null 許容
msg
型: string
status
型: string 列挙値
値
- success
- failed

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

Integer numbers.
preview_text
型: string
quoteCount
型: integer

Integer numbers.
replyCount
型: integer

Integer numbers.
title
型: string
viewCount
型: integer

Integer numbers.

has_next_page
型: boolean
msg
型: string
next_cursor
型: string
status
型: string 列挙値
値
- success
- error
tweets
型: array object[] ·

data
型: object ·
msg
型: string
status
型: string 列挙値
値
- success
- error

created_at
型: string 形式: date-time

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

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

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

msg
型: string
status
型: string 列挙値
値
- success
- error
trends
型: array object[] ·

meta_description
型: string
name
型: string
rank
型: integer 形式: int64

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

has_next_page
型: boolean

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

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

Cursor for fetching the next page of results
status
型: string 列挙値

Status of the request
値
- success
- error

automatedBy
型: string

Indicates who automated the account
canDm
型: boolean

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

URL of the cover picture
createdAt
型: string

Account creation date
description
型: string

Description of the user
favouritesCount
型: integer

Number of favorites
followers
型: integer

Number of followers
following
型: integer

Number of followings
hasCustomTimelines
型: boolean

Indicates if the user has custom timelines
id
型: string

ID of the user
isAutomated
型: boolean

Indicates if the account is automated
isBlueVerified
型: boolean

Indicates if the user is blue verified
isTranslator
型: boolean

Indicates if the user is a translator
location
型: string

Location of the user
mediaCount
型: integer

Number of media items
message
型: string

Message about the account
name
型: string

Name of the user
pinnedTweetIds
型: array string[]

List of pinned tweet IDs
possiblySensitive
型: boolean

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

URL of the profile picture
statusesCount
型: integer

Number of statuses
type
型: string

Type of the user
unavailable
型: boolean

Indicates if the account is unavailable
unavailableReason
型: string

Reason for unavailability
url
型: string

URL of the user's profile
userName
型: string

Username of the user
verifiedType
型: string

Type of verification
withheldInCountries
型: array string[]

List of countries where the user is withheld

display_url
型: string

Display URL
expanded_url
型: string

Expanded URL
indices
型: array integer[]

Indices of the URL
url
型: string

URL

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

Indicates if there are more results available
msg
型: string

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

Cursor for fetching the next page of results
status
型: string 列挙値

Status of the request
値
- success
- error

has_next_page
型: boolean

Indicates if there are more results available
msg
型: string

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

Cursor for fetching the next page of results
status
型: string 列挙値

Status of the request
値
- success
- error
tweets
型: array object[] ·

Array of tweets from the list

community_info
型: object ·
msg
型: string
status
型: string 列挙値
値
- success
- error

admin
型: object ·
banner_url
型: string null 許容
created_at
型: string null 許容
creator
型: object ·
description
型: string null 許容
id
型: string null 許容
invites_policy
型: string null 許容
is_nsfw
型: boolean
is_pinned
型: boolean
join_policy
型: string null 許容
member_count
型: integer

Integer numbers.
members_preview
型: array object[]
空のオブジェクト
moderator_count
型: integer

Integer numbers.
name
型: string null 許容
primary_topic
型: object
question
型: string null 許容
role
型: string null 許容
rules
型: array object[]
search_tags
型: array string[]

SimilarWeb v5 response envelope metadata.

status
型: string
必須

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

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

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

Normalized request parameters used for this lookup.

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

Integer numbers.
cursor
型: string null 許容
success
型: boolean
propertyName
型: anything

propertyName
型: anything

after
型: string null 許容
credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
posts
型: array object[] ·
success
型: boolean
propertyName
型: anything

propertyName
型: anything

credits_remaining
型: integer

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

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

Integer numbers.
success
型: boolean
weekly_active_users
型: integer

Integer numbers.
weekly_contributions
型: integer

Integer numbers.
propertyName
型: anything

error
型: string

A short error message.
message
型: string

A more detailed error message.

JSON explanation response returned when response_mode is NON_STREAMING.

message
型: string
必須

Generated explanation text.

search_id
型: string
必須

ID of the search to explain
detail_level
型: string 列挙値

Level of detail in the explanation
値
- BRIEF
- MODERATE
- DETAILED
language
型: string

Language code for the explanation (e.g., en, zh, ar)
response_mode
型: string 列挙値

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

id
型: string
必須

Unique identifier for the search request
results
型: array object[] ·
必須

List of academic paper results

authors
型: array string[]
必須

List of authors
link
型: string 形式: uri
必須

URL to access the full paper
number_of_citations
型: integer
最小値:
0
必須

Number of citations the paper has received
snippet
型: string
必須

Brief summary or abstract of the paper
title
型: string
必須

Title of the academic paper
journal
型: string

Journal or conference name
year
型: integer
最小値:
1900
最大値:
2030

Publication year

id
型: string
必須

Unique identifier for the search request
results
型: array object[] ·
必須

List of web search results

link
型: string 形式: uri
必須

URL to access the web page
snippet
型: string
必須

Brief summary or preview of the web page content
title
型: string
必須

Title of the web page
display_url
型: string

Display-friendly URL
published_date
型: string 形式: date-time

Publication date of the web page

id
型: string
必須

Unique identifier for the search request
results
型: array object[] ·
必須

List of smart search results combining web and academic content
search_type
型: string 列挙値

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

link
型: string 形式: uri
必須

URL to access the content
snippet
型: string
必須

Brief summary or abstract
title
型: string
必須

Title of the result
authors
型: array string[]

List of authors (for academic content)
number_of_citations
型: integer
最小値:
0

Number of citations (for academic content)
relevance_score
型: number
最小値:
0
最大値:
1

Relevance score of the result
type
型: string 列挙値

Type of the result
値
- web
- academic

boards
型: array object[]
credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
success
型: boolean
propertyName
型: anything

credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
pins
型: array object[]
success
型: boolean
propertyName
型: anything

createdAt
型: string
credits_remaining
型: integer

Integer numbers.
description
型: string
entityId
型: string
originPinner
型: object null 許容
pinner
型: object
repinCount
型: integer

Integer numbers.
success
型: boolean
totalReactionCount
型: integer

Integer numbers.
propertyName
型: anything

earnings
型: object ·

annual
型: object ·
currency
型: string null 許容

ISO currency code (e.g. USD).
fiscal_period
型: string null 許容

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

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

The requested ticker symbol.

capital_expenditure
型: number null 許容
cash_and_equivalents
型: number null 許容
change_in_cash_and_equivalents
型: number null 許容
currency
型: string null 許容

ISO currency code (e.g. USD).
earnings_per_share
型: number null 許容
eps_surprise
型: string 列挙値

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

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

Estimated revenue. Returned only when available.
fiscal_period
型: string null 許容

Fiscal period label (e.g. 2025-Q4 or 2025-FY).
free_cash_flow
型: number null 許容
free_cash_flow_chg
型: number

Percentage change in free cash flow. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
gross_profit
型: number null 許容
gross_profit_chg
型: number

Percentage change in gross profit. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_cash_flow_from_financing
型: number null 許容
net_cash_flow_from_financing_chg
型: 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
型: number null 許容
net_cash_flow_from_investing_chg
型: 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
型: number null 許容
net_cash_flow_from_operations_chg
型: number

Percentage change in net cash flow from operations. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
net_income
型: number null 許容
net_income_chg
型: number

Percentage change in net income. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
operating_income
型: number null 許容
operating_income_chg
型: number

Percentage change in operating income. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
revenue
型: number null 許容
revenue_chg
型: number

Percentage change in revenue. QoQ in quarterly payload and YoY in annual payload. Returned only when calculable.
revenue_surprise
型: string 列挙値

Revenue surprise classification versus estimate. Returned only when available.
値
- BEAT
- MISS
- MEET
shareholders_equity
型: number null 許容
total_assets
型: number null 許容
total_debt
型: number null 許容
total_liabilities
型: number null 許容
weighted_average_shares
型: number null 許容
weighted_average_shares_diluted
型: number null 許容

results
型: array object[]

Stocks matching the requested screener filters.

filters
型: array object[] 1…
必須

An array of filter objects to apply to the search.
currency
型: string 列挙値

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

Whether to return historical financial data.
limit
型: integer
最小値:
1
最大値:
100

The maximum number of results to return.
order_by
型: string 列挙値

The field to order the results by. Use -field to order in descending order.
値
- ticker
- -ticker
- report_period
- -report_period
period
型: string 列挙値

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

snapshot
型: object ·

asset_turnover
型: number null 許容

Revenue divided by average total assets.
book_value_growth
型: number null 許容

Year-over-year growth in book value.
book_value_per_share
型: number null 許容

Shareholders' equity divided by shares outstanding.
cash_ratio
型: number null 許容

Cash and cash equivalents divided by current liabilities.
current_ratio
型: number null 許容

Current assets divided by current liabilities.
days_sales_outstanding
型: number null 許容

Average accounts receivable divided by revenue over the period.
debt_to_assets
型: number null 許容

Total debt divided by total assets.
debt_to_equity
型: number null 許容

Total debt divided by shareholders' equity.
earnings_growth
型: number null 許容

Year-over-year growth in earnings.
earnings_per_share
型: number null 許容

Net income divided by weighted average shares outstanding.
earnings_per_share_growth
型: number null 許容

Growth in earnings per share over the period.
ebitda_growth
型: number null 許容

Growth in EBITDA over the period.
enterprise_value
型: number null 許容

The total value of the company (market cap + debt - cash).
enterprise_value_to_ebitda_ratio
型: number null 許容

Enterprise value to EBITDA ratio.
enterprise_value_to_revenue_ratio
型: number null 許容

Enterprise value to revenue ratio.
free_cash_flow_growth
型: number null 許容

Growth in free cash flow over the period.
free_cash_flow_per_share
型: number null 許容

Free cash flow divided by shares outstanding.
free_cash_flow_yield
型: number null 許容

Free cash flow yield.
gross_margin
型: number null 許容

Gross profit as a percentage of revenue.
interest_coverage
型: number null 許容

EBIT divided by interest expense.
inventory_turnover
型: number null 許容

Cost of goods sold divided by average inventory.
market_cap
型: number null 許容

The total market capitalization (stock price × shares outstanding).
net_margin
型: number null 許容

Net income as a percentage of revenue.
operating_cash_flow_ratio
型: number null 許容

Operating cash flow divided by current liabilities.
operating_cycle
型: number null 許容

Inventory turnover + receivables turnover.
operating_income_growth
型: number null 許容

Growth in operating income over the period.
operating_margin
型: number null 許容

Operating income as a percentage of revenue.
payout_ratio
型: number null 許容

Dividends paid as a percentage of net income.
peg_ratio
型: number null 許容

Price to earnings growth ratio.
price_to_book_ratio
型: number null 許容

Price to book ratio.
price_to_earnings_ratio
型: number null 許容

Price to earnings ratio.
price_to_sales_ratio
型: number null 許容

Price to sales ratio.
quick_ratio
型: number null 許容

Quick assets divided by current liabilities.
receivables_turnover
型: number null 許容

Revenue divided by average accounts receivable.
return_on_assets
型: number null 許容

Net income as a percentage of total assets.
return_on_equity
型: number null 許容

Net income as a percentage of shareholders' equity.
return_on_invested_capital
型: number null 許容

Net operating profit after taxes as a percentage of invested capital.
revenue_growth
型: number null 許容

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

The ticker symbol of the company.
working_capital_turnover
型: number null 許容

Revenue divided by average working capital.

financial_metrics
型: array object[] ·

Historical financial metrics and ratios for the requested ticker.

asset_turnover
型: number

Revenue divided by average total assets.
book_value_growth
型: number

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

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

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

Current assets divided by current liabilities.
days_sales_outstanding
型: number

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

Total debt divided by total assets.
debt_to_equity
型: number

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

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

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

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

Growth in EBITDA over the period.
enterprise_value
型: number

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

Enterprise value to EBITDA ratio.
enterprise_value_to_revenue_ratio
型: number

Enterprise value to revenue ratio.
free_cash_flow_growth
型: number

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

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

Free cash flow yield.
gross_margin
型: number

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

EBIT divided by interest expense.
inventory_turnover
型: number

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

The market capitalization of the company.
net_margin
型: number

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

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

Inventory turnover + receivables turnover.
operating_income_growth
型: number

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

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

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

Price to earnings growth ratio.
price_to_book_ratio
型: number

Price to book ratio.
price_to_earnings_ratio
型: number

Price to earnings ratio.
price_to_sales_ratio
型: number

Price to sales ratio.
quick_ratio
型: number

Quick assets divided by current liabilities.
receivables_turnover
型: number

Revenue divided by average accounts receivable.
return_on_assets
型: number

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

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

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

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

The ticker symbol of the company.
working_capital_turnover
型: number

Revenue divided by average working capital.

next_page_url
型: string

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

close
型: number

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

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

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

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

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

The timestamp of the price in milliseconds since epoch.
volume
型: integer 形式: number

The volume of the ticker in the given time period.

news
型: array object[] ·

author
型: string

The author of the news article.
date
型: string 形式: date

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

The sentiment of the news article.
source
型: string

The source of the news article.
ticker
型: string

The ticker symbol.
title
型: string

The title of the news article.
url
型: string 形式: uri

The URL of the news article.

financials
型: object

consolidated_income
型: number

The consolidated income of the company.
cost_of_revenue
型: number

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

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

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

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

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

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

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

The gross profit of the company.
income_tax_expense
型: number

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

The interest expenses of the company.
net_income
型: number

The net income of the company.
net_income_common_stock
型: number

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

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

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

The operating expenses of the company.
operating_income
型: number

The operating income of the company.
period
型: string 列挙値

The time period of the income statement.
値
- quarterly
- ttm
- annual
preferred_dividends_impact
型: number

The impact of preferred dividends on the net income of the company.
report_period
型: string 形式: date

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

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

The total revenue of the company.
selling_general_and_administrative_expenses
型: number

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

The ticker symbol.
weighted_average_shares
型: number

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

The diluted weighted average shares of the company.

accumulated_other_comprehensive_income
型: number

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

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

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

The current assets of the company.
current_debt
型: number

The current debt of the company.
current_investments
型: number

The current investments of the company.
current_liabilities
型: number

The current liabilities of the company.
deferred_revenue
型: number

The deferred revenue of the company.
deposit_liabilities
型: number

The deposit liabilities of the company.
fiscal_period
型: string

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

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

The inventory of the company.
investments
型: number

The investments of the company.
non_current_assets
型: number

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

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

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

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

The outstanding shares of the company.
period
型: string 列挙値

The time period of the balance sheet.
値
- quarterly
- ttm
- annual
property_plant_and_equipment
型: number

The property, plant, and equipment of the company.
report_period
型: string 形式: date

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

The retained earnings of the company.
shareholders_equity
型: number

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

The tax assets of the company.
tax_liabilities
型: number

The tax liabilities of the company.
ticker
型: string

The ticker symbol.
total_assets
型: number

The total assets of the company.
total_debt
型: number

The total debt of the company.
total_liabilities
型: number

The total liabilities of the company.
trade_and_non_trade_payables
型: number

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

The trade and non-trade receivables of the company.

business_acquisitions_and_disposals
型: number

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

The capital expenditure of the company.
change_in_cash_and_equivalents
型: number

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The net income of the company.
period
型: string 列挙値

The time period of the cash flow statement.
値
- quarterly
- ttm
- annual
report_period
型: string 形式: date

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

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

The ticker symbol.

snapshot
型: object ·

day_change
型: number

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

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

The market capitalization of the company.
price
型: number

The current price of the stock.
ticker
型: string

The ticker symbol.
time
型: string

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

The timestamp of the price snapshot in milliseconds since epoch.

cash_flow_statements
型: array object[] ·

balance_sheets
型: array object[] ·

income_statements
型: array object[] ·

accession_number
型: string

The accession number of the filing.
cik
型: string

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

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

The quarter of the filing.
ticker
型: string

The ticker symbol of the company.
year
型: integer

The year of the filing.

name
型: string

The item name.
number
型: string

The item number.
text
型: string

The item text.

filings
型: array object[] ·

accession_number
型: string

The accession number of the filing.
cik
型: integer

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

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

The date of the report.
ticker
型: string

The ticker symbol.
url
型: string 形式: uri

The URL of the SEC filing.

company_facts
型: object ·

category
型: string

The category of the company.
cik
型: string

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

The exchange of the company.
industry
型: string

The industry of the company.
is_active
型: boolean

Whether the company is currently active.
listing_date
型: string 形式: date

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

The location of the company.
market_cap
型: number

The market capitalization of the company.
name
型: string

The name of the company.
number_of_employees
型: number

The number of employees at the company.
sec_filings_url
型: string 形式: uri

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

The sector of the company.
sic_code
型: string

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

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

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

The ticker symbol of the company.
website_url
型: string 形式: uri

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

The weighted average shares of the company.

insider_trades
型: array object[] ·

filing_date
型: string 形式: date

The date the transaction was filed.
is_board_director
型: boolean

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

The name of the issuing company.
name
型: string

The name of the insider.
security_title
型: string

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

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

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

The ticker symbol of the company.
title
型: string

The title of the insider.
transaction_date
型: string 形式: date

The date of the transaction.
transaction_price_per_share
型: number

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

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

The total value of the transaction.

search_results
型: array object[]

line_items
型: array string[] 1…
必須

An array of line items to apply to the search.
tickers
型: array string[] 1…
必須

An array of tickers to apply to the search.
limit
型: integer
最小値:
1

The maximum number of results to return.
period
型: string 列挙値

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

interest_rates
型: array object[] ·

bank
型: string

The symbol of the central bank.
date
型: string

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

The name of the central bank.
rate
型: number

The interest rate of the central bank.

credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
reels
型: array object[]
success
型: boolean
propertyName
型: anything

credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
profiles
型: array object[]
query
型: string
success
型: boolean
propertyName
型: anything

credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
hashtag
型: string
media_type
型: string
posts
型: array object[]
success
型: boolean
propertyName
型: anything

credits_remaining
型: integer

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

comments
型: array object[]
credits_remaining
型: integer

Integer numbers.
cursor
型: string null 許容
success
型: boolean
propertyName
型: anything

credits_remaining
型: integer

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

credits_remaining
型: integer

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

credits_remaining
型: integer

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

credits_remaining
型: integer

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

credits_remaining
型: integer

Integer numbers.
items
型: array object[]
max_id
型: string null 許容
next_max_id
型: string null 許容
success
型: boolean
propertyName
型: anything

biography
型: string
credits_remaining
型: integer

Integer numbers.
follower_count
型: integer

Integer numbers.
following_count
型: integer

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

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

credits_remaining
型: integer

Integer numbers.
data
型: object
success
型: boolean
propertyName
型: 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
型: string 形式: date-timenull 許容

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

When the job was accepted.
endpoint
型: 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
型: object null 許容

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

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

Always "integration_async_job".
output
null 許容

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

True when the result has been retained past its retention window and is no longer retrievable.
pricing
型: object
status
型: string 列挙値

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

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

error
型: object
status
型: object
propertyName
型: anything

型: object ·

additional_notices
型: array string[]

additional notices
asset_platform_id
型: string

coin asset platform ID
block_time_in_minutes
型: number

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

coin categories
community_data
型: object

coin community data
contract_address
型: string

coin contract address
country_origin
型: string

coin country of origin
description
型: object

coin description
detail_platforms
型: object

detailed coin asset platform and contract address
developer_data
型: object

coin developer data
genesis_date
型: string 形式: date-timenull 許容

coin genesis date
hashing_algorithm
型: string null 許容

blockchain hashing algorithm
id
型: string

coin ID
image
型: object

coin image url
last_updated
型: string 形式: date-time

coin last updated timestamp
links
型: object

links
localization
型: object

coin name localization
market_cap_rank
型: number

coin rank by market cap
market_cap_rank_with_rehypothecated
型: number

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

coin market data
name
型: string

coin name
platforms
型: object

coin asset platform and contract address
preview_listing
型: boolean

preview listing coin
public_notice
型: string null 許容

public notice
sentiment_votes_down_percentage
型: number

coin sentiment votes down percentage
sentiment_votes_up_percentage
型: number

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

coin status updates
symbol
型: string

coin symbol
tickers
型: array object[]

coin tickers
watchlist_portfolio_users
型: number

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

coin web slug

propertyName
型: object
- propertyName
  型: anything

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

型: array object[]

型: array object[]

propertyName
型: anything

型: array array number[][]

型: array string[]

analyst_estimates
型: array object[] ·

earnings_per_share
型: number

The estimated earnings per share.
fiscal_period
型: string 形式: date

The fiscal period of the analyst estimate.
period
型: string 列挙値

The period of the analyst estimate.
値
- annual
- quarterly
revenue
型: integer

The estimated revenue.

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

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

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

Unique identifier for the completion.
model
型: string

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

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

messages
型: array object[]
必須

A list of messages comprising the conversation so far.
model
型: string 列挙値
必須

The Sonar model to use.
値
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
型: number
最小値:
0
最大値:
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
型: integer

The maximum number of tokens to generate in the response.
presence_penalty
型: number
最小値:
-2
最大値:
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
型: boolean

Whether to return citations and search results in the response.
search_context
型: string 列挙値

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

Limit search to specific domains.
search_recency_filter
型: string 列挙値

Filter search results by recency.
値
- month
- week
- day
- hour
stream
型: boolean 列挙値
定数:
false

Only non-streaming JSON responses are covered by this public contract. Set false.
値
- false
temperature
型: number
最小値:
0
最大値:
2

Sampling temperature between 0 and 2. Lower values make output more focused and deterministic.
top_k
型: integer
最小値:
0
最大値:
2048

The number of tokens to keep for top-k filtering.
top_p
型: number
最小値:
0
最大値:
1

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

contacts
型: array object[]

External contact links identified during the lookup.
email
型: string null 許容

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

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

Platform parsed from the profile URL: tiktok, instagram, or youtube.
platformUserId
型: string null 許容

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

Normalized profile URL used for this request.
quota
型: object ·
region
型: string null 許容

Creator region, if available.
username
型: string null 許容

Creator username returned by the lookup chain.

cost
型: number

Resource units consumed by this lookup. This is not a USD amount or a Felo credit charge.
remainingQuota
型: 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