CityFALCON Financial API

{
  "$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"
    }
  },
  "required": [
    "identifiers"
  ],
  "title": "Retrieves insider transactions for US companies",
  "type": "object"
}

{
  "$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"
    }
  },
  "required": [
    "identifiers"
  ],
  "title": "Retrieves investor relations document links and metadata",
  "type": "object"
}

{
  "$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"
    }
  },
  "required": [
    "identifiers"
  ],
  "title": "Sentiment for entities",
  "type": "object"
}

{
  "$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 only. Not commodities and not macro topics -- those go in identifiers with identifier_type = assets. Cannot be combined with the asset, ticker or full_ticker identifiers.",
      "requiredOneOf": "selector",
      "type": "string"
    },
    "events": {
      "description": "Comma-separated EVENT slugs -- defined occurrences such as a stock buyback or an analyst sell rating. Not topic classes (\"people\", \"commodities\" and the like belong in topic_classes) and not macro topics. Browse the slugs: https://www.cityfalcon.ai/help/articles/36799477030301",
      "requiredOneOf": "selector",
      "type": "string"
    },
    "identifier_type": {
      "default": "full_tickers",
      "description": "How identifiers is read. full_tickers for listed companies and crypto ([ticker]_[country]). assets for commodity names and macro topics. tickers for a bare symbol without a country. Must match what you put in identifiers.",
      "enum": [
        "tickers",
        "full_tickers",
        "assets"
      ],
      "type": "string"
    },
    "identifiers": {
      "description": "Comma-separated, and read according to identifier_type. With full_tickers: [ticker]_[country], e.g. AAPL_US, 005930_KR; cryptocurrencies use GLOBAL, e.g. BTC_GLOBAL. With assets: the NAME of a commodity (Aluminium, Brent Crude Oil, Gold, Wheat) or of a macro topic (Inflation, Core CPI, Unemployment Rates, Yield Curve). Leave this empty when you use topic_classes.",
      "example": "AAPL_US,BTC_GLOBAL",
      "requiredOneOf": "selector",
      "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": "Aggregate feed by topic or asset class. Pick from the list: these are the only accepted values. Use this INSTEAD OF identifiers and identifier_type, never alongside them. \"bonds\" means government and sovereign bonds; use \"corporate-bonds\" for corporates. \"events\" is the Major Business and Related Activities class. A macro topic such as Core CPI or Inflation does NOT belong here -- put it in identifiers with identifier_type = assets.",
      "enum": [
        "alternative-dats",
        "bonds",
        "closed-end-funds",
        "commodities",
        "corporate-bonds",
        "cryptocurrencies",
        "events",
        "financial-topics",
        "foreign-exchange",
        "fundamental-analysis",
        "funds",
        "indices",
        "macro-topics",
        "mutual-funds",
        "organisations",
        "other-equity-securities",
        "other-events",
        "people",
        "preferred-stocks",
        "private-companies",
        "products",
        "property",
        "ratings-research-firms",
        "regulations",
        "state-owned-companies",
        "stocks",
        "technical-analysis"
      ],
      "requiredOneOf": "selector",
      "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"
}