Visão Geral da API

Compreender o ecossistema da Deriv API e as suas capacidades principais.

Introdução

A Deriv API fornece acesso programático a serviços de negociação, gestão de conta e dados de mercado para a plataforma de negociação de Options. A API permite que os programadores integrem a robusta infraestrutura de negociação da Deriv nas suas aplicações usando endpoints REST para configuração de conta e ligações WebSocket para negociação em tempo real.

Características principais

Criação e gestão de conta de Options (REST)
Depósitos, levantamentos e consultas de agentes de pagamento (REST)
Streaming de dados de mercado em tempo real (WebSocket)
Negociação de contratos (comprar, vender, atualizar) (WebSocket)
Monitorização de portfólio e conta (WebSocket)
Acesso a dados históricos (WebSocket)
Atualizações em tempo real baseadas em subscrição (WebSocket)
Acesso seguro via OAuth 2.0 ou Personal Access Token (PAT)

Arquitetura da API

A Deriv API consiste em dois componentes complementares concebidos para funcionar em conjunto de forma integrada:

APIs REST

Criação e gestão de conta
Depósitos, levantamentos e consultas de diretório de agentes de pagamento
Geração de OTP para autenticação WebSocket
Monitorização de saúde do sistema
Métodos HTTP padrão (GET, POST)
Pedidos sem estado
Autenticação via cabeçalho Deriv-App-ID + token Authorization: Bearer (OAuth 2.0 ou PAT)

APIs WebSocket

Operações de negociação em tempo real (comprar, vender, propostas)
Estratégias de negociação automatizadas (executar, pausar, retomar, parar)
Transmissão de dados de mercado em tempo real (ticks, símbolos)
Subscrições de dados de conta (saldo, portfólio)
Ligação bidirecional persistente
Notificações push em tempo real
Três tipos de endpoint: public (sem autenticação), demo e real (ambos autenticados via OTP)

Quando usar REST vs WebSocket

Funcionalidade	REST API	API WebSocket
Caso de Utilização	Configuração e gestão de conta	Negociação em tempo real e dados de mercado
Tipo de Ligação	Pedidos HTTP sem estado	Ligação persistente
Autenticação	Cabeçalho Deriv-App-ID + token Bearer (OAuth 2.0 ou PAT)	Baseado em OTP (obtido via REST API); o endpoint público não requer autenticação
Atualizações em Tempo Real	Não (apenas pedido-resposta)	Sim (subscrições)
Exemplos	`POST /trading/v1/options/accounts`, `POST .../{accountId}/otp`, `GET /v1/health`	Comprar contrato, transmitir ticks, obter saldo

Fluxo de trabalho típico

REST: Obtenha um URL WebSocket autenticado através do endpoint OTP (requer o seu token Bearer)
WebSocket: Conecte-se usando o URL autenticado devolvido na resposta OTP
WebSocket: Execute operações de negociação em tempo real

Nota: Os utilizadores recebem uma conta de demonstração predefinida no registo — não precisa de criar uma através da API antes de negociar.

Endpoints de API

URL base REST:

1https://api.derivws.com

Endpoints WebSocket:

1# Public (no authentication required)
2wss://api.derivws.com/trading/v1/options/ws/public
3
4# Demo account (authenticated via OTP)
5wss://api.derivws.com/trading/v1/options/ws/demo?otp=YOUR_OTP
6
7# Real account (authenticated via OTP)
8wss://api.derivws.com/trading/v1/options/ws/real?otp=YOUR_OTP

O OTP é obtido através da chamada POST /trading/v1/options/accounts/{accountId}/otp — a resposta contém um URL WebSocket pronto a usar com o OTP já incorporado.

Requisitos de ligação:

Cliente com capacidade WebSocket (navegador ou servidor)
Ligação à internet estável
Deriv-App-ID válido e token Bearer para chamadas REST e geração OTP

Descarregar schemas da API

Todos os schemas da API são publicados com cada lançamento de produção como schemas.zip. O ficheiro contém todos os ficheiros de JSON Schema do WebSocket e a especificação OpenAPI 3.1.0 da REST API — prontos para uso offline, geradores de SDK ou ferramentas de cliente.

Transferir schemas.zip →

https://github.com/deriv-com/deriv-api-schemas/releases/latest/download/schemas.zip

Precisa de uma versão específica? Cada lançamento tem um URL versionado no formato …/releases/download/{tag}/schemas.zip. Consulte todos os lançamentos em github.com/deriv-com/deriv-api-schemas/releases.

Próximos passos

Continue com estes guias para começar a construir com a Deriv API:

Introdução Autenticação

Alguma outra questão? Entrar em contacto