Skip to main content
Documentation Powered by Redocly

Tickflow API Reference

This page contains information about each endpoint on Tickflow's REST API.

Base URL

All endpoints share the same base url of https://api.tickflow.io.

Authentication

Tickflow currently offers services without authentication — no API keys necessary.

Rate Limit

There is a rate limit of 15 requests per minute.

Stock Screening

This endpoint lets you screen over 4000+ US equities by dozens of possible fields. You can screen by fundamental data like gross_profits or debt_to_equity and market data like 52week_high and market_cap. These screeners are provided through the filters parameter.

You can also query data for the selected stocks by using the fields parameter. You can find the fields available in the Data Reference.

This endpoint can be reached at POST https://api.tickflow.io/v1/stocks/screener.

Request Body schema: application/json
fields
required
Array of strings

The fields you wish to query for the resulting stocks. See stock fields.

required
Array of objects

The filters you wish to screen by. Each filter will be applied to the screening by a logical AND.

sort_by
string

By default, results are sorted by symbol. You can choose one of the fields you provided in the fields parameter to sort by.

string

Responses

Response Schema: application/json
status
integer

The response status code.

result
object

Contains the resulting symbols and their queried fields.

Request samples

Content type
application/json
{
  • "fields": [
    • "market_cap",
    • "day_close",
    • "revenue_growth",
    • "sector"
    ],
  • "filters": [
    • {
      • "field": "market_cap",
      • "comparator": ">",
      • "threshold": 200000000000
      },
    • {
      • "field": "sector",
      • "comparator": "=",
      • "threshold": "technology"
      }
    ],
  • "sort_by": "day_close"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "result": {
    • "TSM": {
      • "sector": "technology",
      • "revenue_growth": 0.435,
      • "day_close": 73.87,
      • "market_cap": 373946941440
      },
    • "NVDA": {
      • "sector": "technology",
      • "revenue_growth": 0.03,
      • "day_close": 125.16,
      • "market_cap": 311898734592
      },
    • "AAPL": {
      • "sector": "technology",
      • "revenue_growth": 0.019,
      • "day_close": 150.43,
      • "market_cap": 2468014718976
      },
    • "MSFT": {
      • "sector": "technology",
      • "revenue_growth": 0.124,
      • "day_close": 237.92,
      • "market_cap": 1774381170688
      }
    }
}

Stock Screening Metadata

This endpoint returns metadata about the equity data available on tickflow. It returns the total number of symbols available, the fields that are available to screen by, and the timestamp the data was last updated.

This endpoint can be reached at GET https://api.tickflow.io/v1/stocks/meta and it takes no request parameters.

Responses

Response Schema: application/json
status
integer
object

Response samples

Content type
application/json
{
  • "status": 200,
  • "result": {
    • "last_updated": "2022-09-24T00:00:00",
    • "number_of_symbols": 2881,
    • "fields_available": [
      • "sector",
      • "ebitda_margins",
      • "profit_margins",
      • "gross_margins",
      • "operating_cashflow",
      • "revenue_growth",
      • "operating_margins",
      • "ebitda",
      • "target_low_price",
      • "gross_profits",
      • "free_cashflow",
      • "target_median_price",
      • "current_price",
      • "earnings_growth",
      • "current_ratio",
      • "return_on_assets",
      • "target_mean_price",
      • "debt_to_equity",
      • "return_on_equity",
      • "target_high_price",
      • "total_cash",
      • "total_debt",
      • "..."
      ]
    }
}

Crypto Screening

This endpoint lets you screen over 100 coins and tokens, including BTC, ETH, LTC and many erc-20 tokens. You can screen by on-chain data like addresses_active_count, fees_gas_used_mean and others. You can also screen by market data.

You can find the fields available to screen by in the Data Reference.

This endpoint can be reached at POST https://api.tickflow.io/v1/crypto/screener.

Request Body schema: application/json
fields
required
Array of strings

The fields you wish to query for the resulting crypto. See crypto fields.

required
Array of objects

The filters you wish to screen by. Each filter will be applied to the screening by a logical AND.

sort_by
string

By default, results are sorted by symbol. You can choose one of the fields you provided in the fields parameter to sort by.

Responses

Response Schema: application/json
status
integer

The response status code.

result
object

Contains the resulting symbols and their queried fields.

Request samples

Content type
application/json
{
  • "fields": [
    • "addresses_count",
    • "transactions_transfers_volume_mean",
    • "market_price_usd_close"
    ],
  • "filters": [
    • {
      • "field": "addresses_count",
      • "comparator": "greater_than",
      • "threshold": 10000000
      }
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "result": {
    • "ETH": {
      • "addresses_count": 160643224,
      • "transactions_transfers_volume_mean": 4.51132491107308,
      • "market_price_usd_close": 1340.938618851911
      },
    • "LTC": {
      • "addresses_count": 155278413,
      • "transactions_transfers_volume_mean": 410.9131701464,
      • "market_price_usd_close": 54.994658735258994
      },
    • "USDT": {
      • "addresses_count": 24379654,
      • "transactions_transfers_volume_mean": 27469.7590801706,
      • "market_price_usd_close": 1.0000725031525888
      }
    }
}

Crypto Screening Metadata

This endpoint returns metadata about the crypto data available on tickflow. It returns the total number of symbols available, the fields that are available to screen by, and the timestamp the data was last updated.

This endpoint can be reached at GET https://api.tickflow.io/v1/crypto/meta and it takes no request parameters.

Responses

Response Schema: application/json
status
integer
object
string

Response samples

Content type
application/json
{
  • "status": 200,
  • "result": {
    • "last_updated": "2022-09-24T00:00:00",
    • "number_of_symbols": 127,
    • "fields_available": [
      • "addresses_count",
      • "addresses_sending_count",
      • "addresses_receiving_count",
      • "addresses_active_count",
      • "addresses_new_non_zero_count",
      • "mining_difficulty_mean",
      • "mining_difficulty_latest",
      • "mining_hash_rate_mean",
      • "transactions_count",
      • "transactions_rate",
      • "transactions_transfers_count",
      • "transactions_transfers_rate",
      • "transactions_transfers_volume_sum",
      • "transactions_transfers_volume_mean",
      • "transactions_transfers_volume_median",
      • "fees_gas_used_sum",
      • "fees_gas_used_mean",
      • "fees_gas_used_median",
      • "fees_gas_limit_tx_mean",
      • "fees_gas_limit_tx_median",
      • "fees_gas_price_mean",
      • "fees_gas_price_median",
      • "fees_volume_sum",
      • "fees_volume_mean",
      • "fees_volume_median",
      • "indicators_sopr",
      • "blockchain_block_height",
      • "blockchain_block_count",
      • "blockchain_block_interval_mean",
      • "blockchain_block_interval_median",
      • "blockchain_block_size_mean",
      • "blockchain_block_size_sum"
      ]
    }
}