# Bitrace Documents

## Docs

- [Authentication](https://docs.bitrace.io/api-reference/authentication.md): How to authenticate with the Bitrace AML API
- [Add Blacklist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/add-blacklist-addresses.md): addBlacklistAddresses - This endpoint adds addresses to the blacklist.
- [Add Whitelist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/add-whitelist-addresses.md): addWhitelistAddresses - This endpoint adds addresses to the whitelist.
- [Delete Blacklist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/delete-blacklist-addresses.md): deleteBlacklistAddresses - This endpoint deletes addresses from the blacklist.
- [Delete Whitelist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/delete-whitelist-addresses.md): deleteWhitelistAddresses - This endpoint deletes addresses from the whitelist.
- [Retrieve Blacklist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/retrieve-blacklist-addresses.md): listBlacklistAddresses - This endpoint retrieves blacklist addresses.
- [Retrieve Whitelist Addresses](https://docs.bitrace.io/api-reference/endpoints/address/retrieve-whitelist-addresses.md): listWhitelistAddresses - This endpoint retrieves whitelist addresses.
- [Retrieve Address Basic Info](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-address-basic.md): getAddressBasic - This endpoint get basic information by given address.
- [Retrieve Bulk Entities](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-bulk-entities.md): listAddressEntities - This endpoint retrieves bulk entities by given addresses.
- [Retrieve Bulk Entities and Risk Assessments](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-bulk-entities-risks.md): listAddressEntitiesAndRisks - This endpoint retrieves bulk entities and risks by given addresses.
- [Retrieve Bulk Risk Assessments](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-bulk-risk-assessments.md): listAddressRisks - This endpoint retrieves bulk risks by given addresses.
- [Retrieve Bulk Risk Scores](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-bulk-risk-scores.md): listAddressRiskScores - This endpoint retrieves bulk risk scores by given addresses.
- [Retrieve Address TopN Counterparties](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-counterparties.md): getAddressCounterparties - This endpoint get counterparties (TopN) by given address.
- [Retrieve Custom Risk Score](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-custom-risk-score.md): getAddressCustomRiskScore - This endpoint retrieves the custom risk scores by given address.
- [Retrieve Entities, Risks and Scores](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-entities-risks-scores.md): getAddressTagsAndScores - This endpoint retrieves the address information by given address,
- [Retrieve Entity](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-entity.md): getAddressEntity - This endpoint retrieves entity by given address.
- [Retrieve Entity and Risk Assessment](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-entity-and-risk.md): getAddressEntityAndRisk - This endpoint retrieves entity and risk by given address.
- [Retrieve Address Freeze Events](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-freeze-events.md): getAddressFreezeEvents - This endpoint get freeze events by given address.
- [Retrieve Risk Assessment](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-risk-assessment.md): getAddressRisk - This endpoint retrieves risk by given address.
- [Retrieve Risk Score](https://docs.bitrace.io/api-reference/endpoints/kya/retrieve-risk-score.md): getAddressRiskScore - This endpoint get risk score by given address.
- [Retrieve Custom Risk Score](https://docs.bitrace.io/api-reference/endpoints/kyt/retrieve-custom-risk-score.md): getTxHashCustomRiskScore - This endpoint retrieves the custom risk scores by given transaction.
- [Retrieve Transaction Risks](https://docs.bitrace.io/api-reference/endpoints/kyt/retrieve-transaction-risks.md): getTransactionRisks - This endpoint retrieves risk informations for the specific transaction.
- [API Overview](https://docs.bitrace.io/api-reference/endpoints/overview.md): Overview of the Bitrace AML API endpoints
- [KYA Supported Chains](https://docs.bitrace.io/api-reference/endpoints/supported-chains/kya-supported-chains.md): List the supported chains on KYA APIs
- [KYT Supported Chains](https://docs.bitrace.io/api-reference/endpoints/supported-chains/kyt-supported-chains.md): List the supported chains on KYT APIs
- [Events](https://docs.bitrace.io/api-reference/endpoints/webhooks/events.md)
- [Introduction](https://docs.bitrace.io/api-reference/endpoints/webhooks/intro.md): Bitrace API service offers a Webhook feature that allows users to receive event notifications.
- [Setup](https://docs.bitrace.io/api-reference/endpoints/webhooks/setup.md): Guide to setup the Webhooks feature on APIs
- [Signatures Rules](https://docs.bitrace.io/api-reference/endpoints/webhooks/signatures.md): The signature ensures the request originated from the legitimate Bitrace AML provider, preventing malicious actors from sending fake webhook events (spoofing).
- [Introduction](https://docs.bitrace.io/api-reference/introduction.md): Welcome to the Bitrace AML API! You can use our API to access Bitrace AML API endpoints, which comprise a comprehensive suite of blockchain and crypto compliance tools to help you equip you with real-time risk detection capabilities, enabling scrutiny of crypto transactions, wallet addresses, and cr…
- [Quickstart](https://docs.bitrace.io/api-reference/quickstart.md): Get started with Bitrace AML API in minutes
- [Rate Limits](https://docs.bitrace.io/api-reference/rate-limits.md): Understanding and managing API rate limits
- [Enumerations](https://docs.bitrace.io/api-reference/resources/enumerations.md): List of enumerations in Bitrace APIs
- [Error Codes](https://docs.bitrace.io/api-reference/resources/error-codes.md): Bitrace AML API uses standard HTTP status codes along with custom error codes to provide detailed information about request issues.
- [Risk Levels](https://docs.bitrace.io/api-reference/resources/risk-levels.md): Bitrace AML API uses a four-tier risk classification system to help you quickly assess the risk level of addresses and transactions.
- [Risk Types](https://docs.bitrace.io/api-reference/resources/risk-types.md): Bitrace AML API detects and categorizes various types of blockchain-related risks. Each risk type corresponds to specific patterns, behaviors, or known entities.
- [Developer API](https://docs.bitrace.io/en/bitrace-aml/api.md)
- [Custom Strategy](https://docs.bitrace.io/en/bitrace-aml/custom-strategies.md): Configure strategies that match your business risk preferences.
- [Fund Tracing](https://docs.bitrace.io/en/bitrace-aml/funding-tracing.md): Intelligent Tracking Lite
- [Introduction](https://docs.bitrace.io/en/bitrace-aml/introduction.md): On-Chain Risk Fund Monitoring & Management Platform
- [Mine](https://docs.bitrace.io/en/bitrace-aml/mine.md)
- [Monitoring](https://docs.bitrace.io/en/bitrace-aml/monitor.md)
- [Quick Search](https://docs.bitrace.io/en/bitrace-aml/quick-search.md): Search by blockchain address or transaction hash (TxHash). User input undergoes format validation—only valid formats return search results.
- [Explorer](https://docs.bitrace.io/en/bitrace-pro/explorer.md): All-in-One On-chain Explorer
- [Graph](https://docs.bitrace.io/en/bitrace-pro/graph.md): On-chain Analysis Charting Tool
- [PRO](https://docs.bitrace.io/en/bitrace-pro/pro.md): Analytics Manager
- [Bitrace Model Score](https://docs.bitrace.io/en/faq/bitrace-model-score.md)
- [Entity Tags](https://docs.bitrace.io/en/faq/entity-tags.md)
- [FAQ](https://docs.bitrace.io/en/faq/q-and-a.md)
- [Risk Tags](https://docs.bitrace.io/en/faq/risk-tags.md)
- [Supported Blockchains](https://docs.bitrace.io/en/faq/support.md)
- [API Billing Guide](https://docs.bitrace.io/en/getting-started/api-billing-instructions.md)
- [About Bitrace](https://docs.bitrace.io/en/getting-started/index.md): Enhancing blockchain risk management and compliance
- [Quick Start](https://docs.bitrace.io/en/getting-started/quickstart.md)
- [Service Level Agreement](https://docs.bitrace.io/en/terms-of-service/service-level-agreement.md)
- [User Agrement](https://docs.bitrace.io/en/terms-of-service/user-agreement.md)

## OpenAPI Specs

- [openapi](https://docs.bitrace.io/api-reference/openapi.json)

## Optional

- [Website](https://bitrace.io/)
- [Blog](https://blog.bitrace.io/)
- [官网](https://bitrace.io/zh)
- [博客](https://blog.bitrace.io/)