Craft API Documentation

Craft API Documentation

• Introduction
• About GraphQL
• Authentication
• Troubleshooting
• Company Data API Introduction
• Getting started: The options below will help you get started with JavaScript, Python, cURL, or Ruby.
• Getting started with JavaScript: Company Data API querying example with JavaScript
• Getting started with Python: Company Data API querying example with Python
• Getting started with Ruby: Company Data API querying example with Ruby
• Getting started with cURL: Company Data API querying example with cURL
• Query Parameters
• Data Categories
• Basic Company Information
• USG Prohibited List
• Security Rating
• Gov Spending
• Unspsc Code
• Patent
• Stock Market
• Tag
• Financials
• Private Valuation
• Funding Rounds
• Income Statement
• Cash Flow Statement
• Balance Sheet
• Revenue Breakdown
• Acquisitions
• Analyst Ratings
• Filing
• Stock Summary: Summary stock market data for this company if it is publicly traded
• Latest Z Score: The most recent Altman Z Score for this company
• Ratios: Financial ratios based on stock market data for this company
• Human capital
• Company Ratings: The employee satisfaction ratings for this company
• Employee Numbers: The employee headcount (including historical data) for this company
• Human Capital Metrics: Human capital metrics for this company - including gender diversity, ethnicity, etc.
• Job Categories: The summary statistics on the job listings data for this company based on how they are distributed into each functional category.
• Jobs: The granular level job detail data for this company
• Key Executives: The key executives and leadership of this company
• Salaries: The salary data reported for specific job categories at this company
• Operating data
• Locations: The corporate office locations for this company. Note: Craft excludes retail locations from our dataset.
• Data Breaches: The reported data breaches that affected this company
• Competitors: The top competitors for this company
• Blacklists: If the company is included on the blacklist records by OFAC
• Twitter Engagement: The engagement this company receives on Twitter
• News Articles: The latest news about the company and blogs posted by the company
• Operating Metrics (KPIs): The sector-specific metrics or Key Performance Indicators for this company
• Sentiment Breakdowns: Sentiments breakdowns of the company
• Sentiment Breakdown Item
• Sentiment External Item
• Sustainability Metrics: ESG Metrics for this company
• Technology Stack: The technologies this company uses in their technology stack
• Twitter Followers: Twitter followers for this company
• Court Filings: Court filings involving this company
• Patents
• Products and Services: United Nations Standard Products and Services Codes (UNSPSC) - https://en.wikipedia.org/wiki/UNSPSC
• Government Spending
• Website Traffic: The website traffic (total number of visitors on a monthly basis) for this company's website
• Compliance Data
• Risks
• GraphQL Enums
• Unspsc Code Level Enum
• Company Status Enum
• Company Type Enum
• Currency Type Enum
• Metric Unit Enum
• Period Type Enum: Periods values for financial and operating data
• Sentiment Breakdown Type Enum: Breakdown types for the segment
• Core data types
• String
• Money Object
• Source Object
• Image Object
• Period Object
• Time Frame
• AcurisAddress
• AcurisAlias
• AcurisBusinessLink
• AcurisContactEntry
• AcurisEvidence
• AcurisGriEntry
• AcurisIdentifier
• AcurisIndividualLink
• AcurisInsEntry
• AcurisNote
• AcurisPoiEntry
• AcurisPosition
• AcurisRegime
• AcurisRelEntry
• AcurisRelEvent
• AcurisRelEventPeriod
• AcurisRreEntry
• AcurisRreEvent
• AcurisSanEntries
• AcurisSanEntry
• AcurisSanEvent
• AcurisSoeEntry
• AcurisPepEntry
• AcurisStatus: Status of compliance data requested and matched
• Risk
• AdditionalInfo: Additional information field
• RiskRating: RiskRating interface
• RiskHighlight: Highlights field
• RiskRatingInt: Integer type RiskRating
• RiskRatingIntData: Integer type RiskRating data
• RiskRatingIntScaleItem: Integer type RiskRating scale
• RiskRatingIntValueRange
• RiskRatingFloat
• RiskRatingFloatData
• RiskRatingFloatScaleItem
• RiskRatingFloatValueRange
• ColorLinearGradient
• RiskRatingString
• RiskRatingStringData
• RiskRatingStringScaleItem
• Additional data types
• PageInfo
• Query examples
• Restrictions on Usage: This document describes the limits and quotas of requesting the Company Data API and Alerts APIs
• Usage
• Newly Profiled Companies API Introduction
• Query
• Basic Company
• Alerts API Introduction
• Getting started: The options below will help you get started querying Alerts API with JavaScript, Python, cURL or Ruby
• Getting started with JavaScript: Alerts API querying example with JavaScript
• Getting started with Python: Alerts API querying example with Python
• Getting started with Ruby: Alerts API querying example with Ruby
• Getting started with cURL: Alerts API querying example with cURL
• Alerts API Queries
• Pagination: This guide will help you get started with fetching sequences of Alerts from the Alerts API
• Filtering and sorting
• Alerts API Reference: This page describes types of data available in the Alerts API
• Alert Object
• Filter Object: This page specifies all the fields available for filtering in the Alerts API
• Order Object: This page specifies the shape of argument allowing configuring the sorting order of the Alerts API output
• Payload Object: This page includes some sample payloads for Alerts from different datasets.
• Query examples: This page provides additional examples of various queries for Alerts API
• Restrictions on Usage

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.craft.co/master.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.