# Craft API Documentation ## Craft API Documentation - [Introduction](https://docs.craft.co/master) - [About GraphQL](https://docs.craft.co/about-graphql) - [Authentication](https://docs.craft.co/authentication) - [Troubleshooting](https://docs.craft.co/error-handling) - [Company Data API Introduction](https://docs.craft.co/company-data-api/introduction) - [Getting started](https://docs.craft.co/company-data-api/getting-started): The options below will help you get started with JavaScript, Python, cURL, or Ruby. - [Getting started with JavaScript](https://docs.craft.co/company-data-api/getting-started/getting-started-with-javascript): Company Data API querying example with JavaScript - [Getting started with Python](https://docs.craft.co/company-data-api/getting-started/data-api-python): Company Data API querying example with Python - [Getting started with Ruby](https://docs.craft.co/company-data-api/getting-started/getting-started-with-ruby): Company Data API querying example with Ruby - [Getting started with cURL](https://docs.craft.co/company-data-api/getting-started/data-api-curl): Company Data API querying example with cURL - [Query Parameters](https://docs.craft.co/company-data-api/ways-to-query) - [Data Categories](https://docs.craft.co/company-data-api/data-points) - [Basic Company Information](https://docs.craft.co/company-data-api/data-points/basic-company-information) - [USG Prohibited List](https://docs.craft.co/company-data-api/data-points/basic-company-information/usg-prohibited-list) - [Security Rating](https://docs.craft.co/company-data-api/data-points/basic-company-information/security-rating) - [Gov Spending](https://docs.craft.co/company-data-api/data-points/basic-company-information/gov-spending) - [Unspsc Code](https://docs.craft.co/company-data-api/data-points/basic-company-information/unspsc-code) - [Patent](https://docs.craft.co/company-data-api/data-points/basic-company-information/patent) - [Stock Market](https://docs.craft.co/company-data-api/data-points/basic-company-information/stock-market) - [Tag](https://docs.craft.co/company-data-api/data-points/basic-company-information/tag) - [Financials](https://docs.craft.co/company-data-api/data-points/financials) - [Private Valuation](https://docs.craft.co/company-data-api/data-points/financials/private-valuation) - [Funding Rounds](https://docs.craft.co/company-data-api/data-points/financials/funding-round) - [Income Statement](https://docs.craft.co/company-data-api/data-points/financials/income-statements) - [Cash Flow Statement](https://docs.craft.co/company-data-api/data-points/financials/cash-flow-statement-object) - [Balance Sheet](https://docs.craft.co/company-data-api/data-points/financials/balance-sheet-object) - [Revenue Breakdown](https://docs.craft.co/company-data-api/data-points/financials/revenue-breakdowns) - [Acquisitions](https://docs.craft.co/company-data-api/data-points/financials/acquisition-object) - [Analyst Ratings](https://docs.craft.co/company-data-api/data-points/financials/untitled-1-2) - [Filing](https://docs.craft.co/company-data-api/data-points/financials/filing) - [Stock Summary](https://docs.craft.co/company-data-api/data-points/financials/stock-summary): Summary stock market data for this company if it is publicly traded - [Latest Z Score](https://docs.craft.co/company-data-api/data-points/financials/latest-z-score): The most recent Altman Z Score for this company - [Ratios](https://docs.craft.co/company-data-api/data-points/financials/ratios): Financial ratios based on stock market data for this company - [Human capital](https://docs.craft.co/company-data-api/data-points/human-capital) - [Company Ratings](https://docs.craft.co/company-data-api/data-points/human-capital/company-ratings-object): The employee satisfaction ratings for this company - [Employee Numbers](https://docs.craft.co/company-data-api/data-points/human-capital/employee-numbers): The employee headcount (including historical data) for this company - [Human Capital Metrics](https://docs.craft.co/company-data-api/data-points/human-capital/untitled-5): Human capital metrics for this company - including gender diversity, ethnicity, etc. - [Job Categories](https://docs.craft.co/company-data-api/data-points/human-capital/untitled-4): The summary statistics on the job listings data for this company based on how they are distributed into each functional category. - [Jobs](https://docs.craft.co/company-data-api/data-points/human-capital/untitled-3): The granular level job detail data for this company - [Key Executives](https://docs.craft.co/company-data-api/data-points/human-capital/untitled-2): The key executives and leadership of this company - [Salaries](https://docs.craft.co/company-data-api/data-points/human-capital/untitled-1): The salary data reported for specific job categories at this company - [Operating data](https://docs.craft.co/company-data-api/data-points/operating-data) - [Locations](https://docs.craft.co/company-data-api/data-points/operating-data/untitled): The corporate office locations for this company. Note: Craft excludes retail locations from our dataset. - [Data Breaches](https://docs.craft.co/company-data-api/data-points/operating-data/data-breach-object): The reported data breaches that affected this company - [Competitors](https://docs.craft.co/company-data-api/data-points/operating-data/competitor-object): The top competitors for this company - [Blacklists](https://docs.craft.co/company-data-api/data-points/operating-data/blacklist-object): If the company is included on the blacklist records by OFAC - [Twitter Engagement](https://docs.craft.co/company-data-api/data-points/operating-data/twitterengagementitem-object): The engagement this company receives on Twitter - [News Articles](https://docs.craft.co/company-data-api/data-points/operating-data/untitled-1): The latest news about the company and blogs posted by the company - [Operating Metrics (KPIs)](https://docs.craft.co/company-data-api/data-points/operating-data/untitled-2): The sector-specific metrics or Key Performance Indicators for this company - [Sentiment Breakdowns](https://docs.craft.co/company-data-api/data-points/operating-data/sentiment-breakdowns): Sentiments breakdowns of the company - [Sentiment Breakdown Item](https://docs.craft.co/company-data-api/data-points/operating-data/sentiment-breakdowns/sentiment-breakdown-item) - [Sentiment External Item](https://docs.craft.co/company-data-api/data-points/operating-data/sentiment-breakdowns/sentiment-breakdown-item/sentiment-external-item) - [Sustainability Metrics](https://docs.craft.co/company-data-api/data-points/operating-data/sustainability-metrics): ESG Metrics for this company - [Technology Stack](https://docs.craft.co/company-data-api/data-points/operating-data/untitled-3): The technologies this company uses in their technology stack - [Twitter Followers](https://docs.craft.co/company-data-api/data-points/operating-data/untitled-4): Twitter followers for this company - [Court Filings](https://docs.craft.co/company-data-api/data-points/operating-data/untitled-5): Court filings involving this company - [Patents](https://docs.craft.co/company-data-api/data-points/operating-data/patents) - [Products and Services](https://docs.craft.co/company-data-api/data-points/operating-data/products-and-services): United Nations Standard Products and Services Codes (UNSPSC) - https://en.wikipedia.org/wiki/UNSPSC - [Government Spending](https://docs.craft.co/company-data-api/data-points/operating-data/government-spending) - [Website Traffic](https://docs.craft.co/company-data-api/data-points/operating-data/website-traffic): The website traffic (total number of visitors on a monthly basis) for this company's website - [Compliance Data](https://docs.craft.co/company-data-api/data-points/operating-data/compliance-data) - [Risks](https://docs.craft.co/company-data-api/data-points/operating-data/risks) - [GraphQL Enums](https://docs.craft.co/company-data-api/graphql-enums) - [Unspsc Code Level Enum](https://docs.craft.co/company-data-api/graphql-enums/unspsc-code-level-enum) - [Company Status Enum](https://docs.craft.co/company-data-api/graphql-enums/company-status-enum) - [Company Type Enum](https://docs.craft.co/company-data-api/graphql-enums/company-type-enum) - [Currency Type Enum](https://docs.craft.co/company-data-api/graphql-enums/currency-type-enum) - [Metric Unit Enum](https://docs.craft.co/company-data-api/graphql-enums/metric-unit-enum) - [Period Type Enum](https://docs.craft.co/company-data-api/graphql-enums/period-type-enum): Periods values for financial and operating data - [Sentiment Breakdown Type Enum](https://docs.craft.co/company-data-api/graphql-enums/sentiment-breakdown-type-enum): Breakdown types for the segment - [Core data types](https://docs.craft.co/company-data-api/graphql-objects) - [String](https://docs.craft.co/company-data-api/graphql-objects/string-object) - [Money Object](https://docs.craft.co/company-data-api/graphql-objects/money-object) - [Source Object](https://docs.craft.co/company-data-api/graphql-objects/source-object) - [Image Object](https://docs.craft.co/company-data-api/graphql-objects/image-object) - [Period Object](https://docs.craft.co/company-data-api/graphql-objects/untitled-3) - [Time Frame](https://docs.craft.co/company-data-api/graphql-objects/time-frame) - [AcurisAddress](https://docs.craft.co/company-data-api/graphql-objects/acurisaddress) - [AcurisAlias](https://docs.craft.co/company-data-api/graphql-objects/acurisalias) - [AcurisBusinessLink](https://docs.craft.co/company-data-api/graphql-objects/acurisbusinesslink) - [AcurisContactEntry](https://docs.craft.co/company-data-api/graphql-objects/acuriscontactentry) - [AcurisEvidence](https://docs.craft.co/company-data-api/graphql-objects/acurisevidence) - [AcurisGriEntry](https://docs.craft.co/company-data-api/graphql-objects/acurisgrientry) - [AcurisIdentifier](https://docs.craft.co/company-data-api/graphql-objects/acurisidentifier) - [AcurisIndividualLink](https://docs.craft.co/company-data-api/graphql-objects/acurisindividuallink) - [AcurisInsEntry](https://docs.craft.co/company-data-api/graphql-objects/acurisinsentry) - [AcurisNote](https://docs.craft.co/company-data-api/graphql-objects/acurisnote) - [AcurisPoiEntry](https://docs.craft.co/company-data-api/graphql-objects/acurispoientry) - [AcurisPosition](https://docs.craft.co/company-data-api/graphql-objects/acurisposition) - [AcurisRegime](https://docs.craft.co/company-data-api/graphql-objects/acurisregime) - [AcurisRelEntry](https://docs.craft.co/company-data-api/graphql-objects/acurisrelentry) - [AcurisRelEvent](https://docs.craft.co/company-data-api/graphql-objects/acurisrelevent) - [AcurisRelEventPeriod](https://docs.craft.co/company-data-api/graphql-objects/acurisreleventperiod) - [AcurisRreEntry](https://docs.craft.co/company-data-api/graphql-objects/acurisrreentry) - [AcurisRreEvent](https://docs.craft.co/company-data-api/graphql-objects/acurisrreevent) - [AcurisSanEntries](https://docs.craft.co/company-data-api/graphql-objects/acurissanentries) - [AcurisSanEntry](https://docs.craft.co/company-data-api/graphql-objects/acurissanentry) - [AcurisSanEvent](https://docs.craft.co/company-data-api/graphql-objects/acurissanevent) - [AcurisSoeEntry](https://docs.craft.co/company-data-api/graphql-objects/acurissoeentry) - [AcurisPepEntry](https://docs.craft.co/company-data-api/graphql-objects/acurispepentry) - [AcurisStatus](https://docs.craft.co/company-data-api/graphql-objects/acurisstatus): Status of compliance data requested and matched - [Risk](https://docs.craft.co/company-data-api/graphql-objects/risk) - [AdditionalInfo](https://docs.craft.co/company-data-api/graphql-objects/additionalinfo): Additional information field - [RiskRating](https://docs.craft.co/company-data-api/graphql-objects/riskrating): RiskRating interface - [RiskHighlight](https://docs.craft.co/company-data-api/graphql-objects/riskhighlight): Highlights field - [RiskRatingInt](https://docs.craft.co/company-data-api/graphql-objects/riskratingint): Integer type RiskRating - [RiskRatingIntData](https://docs.craft.co/company-data-api/graphql-objects/riskratingintdata): Integer type RiskRating data - [RiskRatingIntScaleItem](https://docs.craft.co/company-data-api/graphql-objects/riskratingintscaleitem): Integer type RiskRating scale - [RiskRatingIntValueRange](https://docs.craft.co/company-data-api/graphql-objects/riskratingintvaluerange) - [RiskRatingFloat](https://docs.craft.co/company-data-api/graphql-objects/riskratingfloat) - [RiskRatingFloatData](https://docs.craft.co/company-data-api/graphql-objects/riskratingfloatdata) - [RiskRatingFloatScaleItem](https://docs.craft.co/company-data-api/graphql-objects/riskratingfloatscaleitem) - [RiskRatingFloatValueRange](https://docs.craft.co/company-data-api/graphql-objects/riskratingfloatvaluerange) - [ColorLinearGradient](https://docs.craft.co/company-data-api/graphql-objects/colorlineargradient) - [RiskRatingString](https://docs.craft.co/company-data-api/graphql-objects/riskratingstring) - [RiskRatingStringData](https://docs.craft.co/company-data-api/graphql-objects/riskratingstringdata) - [RiskRatingStringScaleItem](https://docs.craft.co/company-data-api/graphql-objects/riskratingstringscaleitem) - [Additional data types](https://docs.craft.co/company-data-api/additional-data-types) - [PageInfo](https://docs.craft.co/company-data-api/additional-data-types/pageinfo) - [Query examples](https://docs.craft.co/company-data-api/example) - [Restrictions on Usage](https://docs.craft.co/company-data-api/restrictions-on-usage): This document describes the limits and quotas of requesting the Company Data API and Alerts APIs - [Usage](https://docs.craft.co/company-data-api/usage) - [Newly Profiled Companies API Introduction](https://docs.craft.co/added-companies-api/added-companies-api-introduction) - [Query](https://docs.craft.co/added-companies-api/basic-query) - [Basic Company](https://docs.craft.co/added-companies-api/basic-query/basic-company) - [Alerts API Introduction](https://docs.craft.co/alerts-api/intro) - [Getting started](https://docs.craft.co/alerts-api/getting-started): The options below will help you get started querying Alerts API with JavaScript, Python, cURL or Ruby - [Getting started with JavaScript](https://docs.craft.co/alerts-api/getting-started/getting-started-with-javascript): Alerts API querying example with JavaScript - [Getting started with Python](https://docs.craft.co/alerts-api/getting-started/getting-started-with-python): Alerts API querying example with Python - [Getting started with Ruby](https://docs.craft.co/alerts-api/getting-started/getting-started-with-ruby): Alerts API querying example with Ruby - [Getting started with cURL](https://docs.craft.co/alerts-api/getting-started/getting-started-with-curl): Alerts API querying example with cURL - [Alerts API Queries](https://docs.craft.co/alerts-api/alerts-api-queries) - [Pagination](https://docs.craft.co/alerts-api/alerts-api-queries/pagination): This guide will help you get started with fetching sequences of Alerts from the Alerts API - [Filtering and sorting](https://docs.craft.co/alerts-api/alerts-api-queries/filtering-and-sorting) - [Alerts API Reference](https://docs.craft.co/alerts-api/alerts-api-reference): This page describes types of data available in the Alerts API - [Alert Object](https://docs.craft.co/alerts-api/alerts-api-reference/alert-object) - [Filter Object](https://docs.craft.co/alerts-api/alerts-api-reference/filter-object): This page specifies all the fields available for filtering in the Alerts API - [Order Object](https://docs.craft.co/alerts-api/alerts-api-reference/order-object): This page specifies the shape of argument allowing configuring the sorting order of the Alerts API output - [Payload Object](https://docs.craft.co/alerts-api/alerts-api-reference/payload-object): This page includes some sample payloads for Alerts from different datasets. - [Query examples](https://docs.craft.co/alerts-api/query-examples): This page provides additional examples of various queries for Alerts API - [Restrictions on Usage](https://docs.craft.co/alerts-api/restrictions-on-usage)