SDK / PYTHON

SDK Python

Guia do cliente Python do repositório Halcyon: autenticação, primeiros pedidos e tratamento de erros.

Estado e obtenção

O repositório do Terminal contém um cliente Python inicial em sdk/python/halcyon, com a classe HalcyonClient. Não está publicado no PyPI. Para o utilizar, precisa de acesso autorizado ao código-fonte; não existe nesta fase um comando público de instalação pip install halcyon que possamos recomendar.

A presença de um método na biblioteca não concede acesso automático a um serviço. A utilização depende da autorização do tenant, das fontes e da disponibilidade contratada.

Configuração básica

A classe usa a biblioteca padrão do Python (urllib) e aceita um URL base e uma chave institucional opcional. Mantenha credenciais fora do código-fonte.

Python

import os
from halcyon import HalcyonClient

client = HalcyonClient(
    base_url="https://terminal.halcyonterminal.app",
    api_key=os.environ.get("HALCYON_API_KEY", "")
)

print(client.health())
print(client.platform())
print(client.developer_capabilities())

O import acima pressupõe que obteve e disponibilizou o pacote de código-fonte do repositório Halcyon no seu ambiente Python.

Métodos representativos

Método	Função
`health()`	Estado da API
`platform()`	Metadados da plataforma
`contracts()`	Registo de contratos
`finance_instruments()`	Universo de instrumentos RF sujeito à disponibilidade
`energy_markets()`	Mercados de energia
`entity_search()`	Pesquisa de entidades com autorização aplicável

Tratamento de erros

O cliente lança HalcyonApiError para respostas HTTP de erro, com atributos de status e payload quando disponíveis.

Python

from halcyon.client import HalcyonApiError

try:
    print(client.platform())
except HalcyonApiError as exc:
    print("HTTP:", exc.status)
    print("Resposta:", exc.payload)

Não publique payloads que possam conter identificadores pessoais ou dados confidenciais da instituição.