CityFALCON Financial API | Apiosk Gateway

About

Use to get the latest news, sentiment timeseries, investor relations docs, and insider transactions for a range of assets and topics related to financial markets.

Base URL

https://gateway.apiosk.com/cityfalcon-financial-api

Technical Specs

Auth MethodNone (x402 payment proof only)

Response FormatJSON

Endpoints4

Endpoints

Method	Path	Description	Cost
GET	/insider_transactions	Retrieves insider transactions	$0.10 default	View details
GET	/investor_relations	Retrieves investor relations	$0.10 default	View details
GET	/services/sentiment	Timeseries sentiment for entities and assets	$0.07 default P0dcsc_sector_level1 exists → $0.10 P0dcsc_sector_level2 exists → $0.10 P0dcsc_sector_level3 exists → $0.10 P0dcsc_sector_level4 exists → $0.10	View details
GET	/stories	Retrieve news and content text, metadata, and analytics	$0.03 default P0with_sentiment = true → $0.07 P0dcsc_sectors exists → $0.05	View details

Endpoint documentation

GET/insider_transactions

$0.10 default

Description

Retrieves insider transactions

Documentation

Insider buying and selling data from SEC Form 4 filings. Filter by transaction type (buy, sell, etc.), whether it is a scheduled sale ("uninformative") or not, and date range.

Pricing

$0.10 default

Parameters

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Query parameters for GET https://api.cityfalcon.com/v0.2/insider_transactions. Auth: access_token.",
  "properties": {
    "end_date": {
      "description": "Retrieve data to/before this date, as a UNIX timestamp, e.g. 1632393143.",
      "example": 1632393143,
      "type": "integer"
    },
    "identifiers": {
      "description": "Comma-separated identifiers, format [ticker]_[trading_country], e.g. \"AAPL_US, 005930_KR\".",
      "example": "AAPL_US",
      "type": "string"
    },
    "info_type": {
      "default": "all",
      "description": "Filter transactions by informative or uninformative.",
      "enum": [
        "all",
        "informative",
        "uninformative"
      ],
      "type": "string"
    },
    "start_date": {
      "description": "Retrieve data from/after this date, as a UNIX timestamp, e.g. 1632393143. Limited to the most recent 30 days; older data is available as CSV from CityFALCON.",
      "example": 1632393143,
      "type": "integer"
    },
    "transaction_type": {
      "description": "Comma-separated transaction types, e.g. \"buy, sell, gift, option exercised, other\".",
      "example": "buy,sell",
      "type": "string"
    }
  },
  "title": "Retrieves insider transactions for US companies",
  "type": "object"
}

GET/investor_relations

$0.10 default

Description

Retrieves investor relations

Documentation

Company IR material and basic metadata — earnings, financial statements, press releases, and similar — for the tickers you ask about, within a date range.

Pricing

$0.10 default

Parameters

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Query parameters for GET https://api.cityfalcon.com/v0.2/investor_relations. Auth: access_token.",
  "properties": {
    "end_date": {
      "description": "Date to retrieve data to. Format YYYY-MM-DD, e.g. \"2023-03-18\".",
      "example": "2023-03-18",
      "format": "date",
      "type": "string"
    },
    "identifiers": {
      "description": "Comma-separated identifiers, format [ticker]_[trading_country], e.g. \"AAPL_US, 005930_KR\".",
      "example": "AAPL_US",
      "type": "string"
    },
    "start_date": {
      "description": "Date to retrieve data from. Format YYYY-MM-DD, e.g. \"2023-03-18\". Limited to the most recent 30 days; older data is available as CSV from CityFALCON.",
      "example": "2023-03-18",
      "format": "date",
      "type": "string"
    },
    "type": {
      "description": "Comma-separated record types, e.g. \"Earnings, Others, Financial Statements, Press Release\".",
      "example": "Earnings,Press Release",
      "type": "string"
    }
  },
  "title": "Retrieves investor relations document links and metadata",
  "type": "object"
}

GET/services/sentiment

$0.07 default

Description

Timeseries sentiment for entities and assets

Documentation

Retrieve a timeseries of sentiment for entities, from regular companies to countries and DCSC sectors over a chosen time period. Average and summary statistics also available.

Pricing

$0.07 default

P0dcsc_sector_level1 exists → $0.10

P0dcsc_sector_level2 exists → $0.10

P0dcsc_sector_level3 exists → $0.10

P0dcsc_sector_level4 exists → $0.10

Parameters

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Query parameters for GET https://api.cityfalcon.com/v0.2/services/sentiment. Auth: access_token.",
  "properties": {
    "average_for_period": {
      "description": "Include average value for the period.",
      "type": "boolean"
    },
    "identifier_type": {
      "default": "full_tickers",
      "description": "Identifier type. Accepted values: full_tickers, countries, dcsc_sectors.",
      "enum": [
        "full_tickers",
        "countries",
        "dcsc_sector_level1",
        "dcsc_sector_level2",
        "dcsc_sector_level3",
        "dcsc_sector_level4"
      ],
      "type": "string"
    },
    "identifiers": {
      "description": "Comma-separated values, interpreted per `identifier_type`. Full tickers are built as [ticker]_[trading_country]: the ticker, an underscore, then the country code of listing — e.g. AAPL_US, 005930_KR. For disambiguation  of companies that share a ticker (e.g., AA_US and AA_GB for American Airlines and British American Tobacco). Cryptocurrencies are not country-bound and use GLOBAL, e.g. BTC_GLOBAL.",
      "example": "AAPL_US,BTC_GLOBAL",
      "type": "string"
    },
    "period": {
      "default": "d1",
      "description": "Time period over which sentiment is calculated: m5 (5 min), m15 (15 min), h1 (1 hour), h8 (8 hours), d1 (1 day), w1 (1 week), mth1 (1 month).",
      "enum": [
        "m5",
        "m15",
        "h1",
        "h8",
        "d1",
        "w1",
        "mth1"
      ],
      "type": "string"
    },
    "statistics_for_period": {
      "description": "Include statistics for the period.",
      "type": "boolean"
    }
  },
  "title": "Sentiment for entities",
  "type": "object"
}

GET/stories

$0.03 default

Description

Retrieve news and content text, metadata, and analytics

Documentation

News with metadata, tags, and CityFALCON relevance scores. Pull stories for specific companies, commodities, and other assets, or for broader groups like topic classes, events, or sectors. Optionally retrieve sentiment for each story.

Data older than 30 days can be requested from CityFALCON.

Pricing

$0.03 default

P0with_sentiment = true → $0.07

P0dcsc_sectors exists → $0.05

Parameters

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Query parameters for GET https://api.cityfalcon.com/v0.2/stories. Auth: access_token.",
  "properties": {
    "categories": {
      "description": "Comma-separated category slugs: mp (major news publications), op (other news publications), r (research publications).",
      "example": "mp,op",
      "type": "string"
    },
    "country_codes": {
      "description": "Comma-separated country codes. Not attached to a company's listing country but to the news.",
      "example": "US,GB",
      "type": "string"
    },
    "dcsc_sector_level": {
      "description": "Select a DCSC sector level to refine the search.",
      "type": "string"
    },
    "dcsc_sectors": {
      "description": "Comma-separated DCSC sector slugs. Do not use with the asset, ticker, or full_ticker identifiers.",
      "type": "string"
    },
    "events": {
      "description": "Comma-separated event slugs. These are defined events such as \"stock buyback\" or \"analyst sell rating\". Browse available slugs: https://www.cityfalcon.ai/help/articles/36799477030301",
      "type": "string"
    },
    "identifier_type": {
      "default": "full_tickers",
      "description": "Full tickers are built as [ticker]_[trading_country], e.g. AAPL_US, 005930_KR. For disambiguation  of companies (e.g., AA_US and AA_GB for American Airlines and British American Tobacco). Cryptocurrencies use GLOBAL, e.g. BTC_GLOBAL. Commodities use the assets type — see https://www.cityfalcon.ai/help/articles/360006813837-Commodity-Identifiers. Macro topics (like inflation) also use the assets type and can be browsed at https://www.cityfalcon.ai/help/articles/36800176706333.",
      "enum": [
        "tickers",
        "full_tickers",
        "assets"
      ],
      "type": "string"
    },
    "identifiers": {
      "description": "Comma-separated list, interpreted per `identifier_type`, e.g. \"AAPL_US, BTC_GLOBAL\".",
      "example": "AAPL_US,BTC_GLOBAL",
      "type": "string"
    },
    "languages": {
      "description": "Comma-separated language codes (e.g. en, de, fr). Leave blank to get content in all languages.",
      "example": "en",
      "type": "string"
    },
    "min_cityfalcon_score": {
      "default": 0,
      "description": "Minimum CityFALCON relevance score, from 0 to 100.",
      "example": 50,
      "format": "float",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "registration_required": {
      "description": "Include / exclude publishers that require user registration.",
      "type": "boolean"
    },
    "time_filter": {
      "default": "d1",
      "description": "Time window: m5 (5 min), m15 (15 min), h1 (1 hour), h8 (8 hours), d1 (1 day), w1 (1 week), mth1 (1 month). Queries cover the most recent 30 days only.",
      "enum": [
        "m5",
        "m15",
        "h1",
        "h8",
        "d1",
        "w1",
        "mth1"
      ],
      "type": "string"
    },
    "topic_classes": {
      "description": "Comma-separated topic-class slugs (aggregate feeds such as \"all stocks\"). Browse topic-class and asset-class slugs at https://www.cityfalcon.ai/help/articles/360006745118.",
      "type": "string"
    },
    "with_sentiment": {
      "description": "Return the sentiment score for each story.",
      "type": "boolean"
    },
    "with_sentiments_by_entities": {
      "description": "Return the sentiment score for each NLU entity (e.g. company) in each story.",
      "type": "boolean"
    }
  },
  "title": "Retrieve news and content text, metadata, and analytics",
  "type": "object"
}