Através da API REST você pode ter acesso aos dados de informações relacionadas ao aplicativo OpLab, como cotações, gráficos, portfólio, entre outras informações. A API é de uso individual e os dados obtidos através dela não podem ser distribuidos sem prévia autorização.
As funções e informações da API estão divididas em duas categorias:
Todas as requisições feitas à API são stateless. Dessa forma, a autenticação ocorre em cada requsição independente de qualquer outro parâmetro
Em cada requisição você deverá passar uma chave no cabeçalho HTTP Access-Token. Opcionalmente, a chave de acesso também poderá ser passada como um parâmetro de query string de nome access_token
Essa chave pode ser obtida através do site do OpLab no link: https://go.oplab.com.br/api. E também ao fazer uma requisição de autenticação no servidor, através dessa rota.
Quando não for possível completar alguma requisição a API irá retornar um dos códigos HTTP abaixo, verifique os possíveis motivos que levaram ao código de erro retornado
Requisição Inválida. Algum parâmetro obrigatório não foi enviado, verifique as informações da rota.
Acesso negado. Os dados de acesso (email e senha) ou o access-token não foram enviados ou estão inválidos, realize uma nova autenticação.
Acesso negado. A assinatura do plano do cliente está expirada, é necessário fazer um novo pagamento.
Acesso negado. O plano assinado pelo cliente não permite o acesso ao recurso solicitado, é necessário fazer um upgrade de plano.
Não encontrado. A rota informada não foi encontrada, verifique se o método HTTP e os parâmetros enviados estão corretos.
Falha no processamento. Não foi possível realizar a ação, verifique os requisitos para a rota que foi chamada.
Falha no processamento. Não foi possível realizar a ação, verifique a mensagem no corpo do retorno para mais detalhes.
Requisição repetitiva. O dado já está sendo processado, aguarde para enviar uma nova requisição.
Erro no servidor. Não foi possível completar o processamento.
Serviço Indisponível. Não foi possível processar a requisição no momento, aguarde para enviar uma nova requisição.
Envia link de recuperação de senha para o e-mail do usuário
| email required | string E-mail cadastrado |
{- "email": "[email protected]"
}{- "error": "string"
}Autentica o usuário no sistema a partir do email e senha
| for | string Default: "default" Enum: "default" "chart" enumDescriptions: {"default":"Plataforma Oplab","chart":"Gráficos TradingView"} Contexto de autenticação |
| email required | string Email do usuário |
| password required | string Senha do usuário |
| name | string Nome do usuário |
| id | integer ID do usuário dentro do OpLab |
object Configurações gerais da conta | |
string Email do usuário | |
| last-login | string <date-time> Data e hora do último login |
| category | string Categoria do plano do usuário |
| permissions | string Código de permissões do usuário |
| acl | string Código de permissões do plano do usuário |
| access-token | string Token de autenticação |
| data-access | string Enum: "REAL_TIME" "DELAYED" "EOD" Nível de acesso ao market data |
| display-name | string Nome do usuário que será mostrado na tela |
| avatar | string Link do gravatar com a imagem de perfil do usuário |
| versions | object Lista de aplicações e suas respecitivas versões |
| days-to-expiration | integer or null Indica os dias restantes do período de teste do usuário |
| default-portfólio | integer ID do portfólio padrão do usuário |
| minimum-version | integer Versão mínima da aplicação que o usuário tem acesso |
| phone-number | string Número do telefone do usuário |
| document-number | string Número do documento do usuário |
| datafeed-access-token | string Token de autenticação para o websocket, só existe se o parâmetro |
| endpoints | Array of strings Lista de URLs do websocket |
Array of objects Lista de servidores websocket | |
object Configurações gerais do sistema |
{- "password": "exemplo123"
}{- "name": "João da Silva",
- "id": 10518,
- "preferences": {
- "interest_rate_type": "SELIC",
- "interest_rate_value": 2.649873258040536,
- "broker": "OTHER",
- "brokerage_fee": 0.8,
- "order_amount": 1000,
- "simulate_price_strategy": "OPLAB",
- "position_price_strategy": [
- "BOOK",
- "OPLAB",
- "LAST",
- "THEORETICAL"
], - "simulate_with_brokerage_and_fees": true,
- "custom_perspective": [
- "bid",
- "ask"
], - "default_web_app_version": null,
- "tinted_moneyness": 10,
- "side_watchlist": true,
- "robot_limit": 10,
- "close_positions_automatically": false
}, - "last-login": "2019-03-26T00:35:02.243Z",
- "category": "MAX",
- "permissions": "ae1f55b1dd8fdd2f3ca49e82b544c513c787040e360fc2ed93df8ae11b64ee20",
- "acl": "KJCUCTC7KREU2RK7KFKUFRGVKTCUJFIEYRK7KBHVEV6VCFKMKFKIWFGVCVIREUKUZMKNEU2VKMIFKE6URMKNKFEQKUIVDUSRKTFRIE6UKESRSJINAVISKPJZJSYRSVJRGF6U2FKJEUKUZMJBEVGVCPKJEUGQKML5WFAUSPJVHV6Q2VKNKE6TGUCUSLIVKF6RCBKRASYSCJKNKE6USJINAUYX2PKBCVEQKUJFHU4UZMKBHVEVCGJ5GEST27JVAU4QKHIVGUKTSUCGJ5GEST2TFRIE6V2EIVJFGLCQJ5JFISUIZHUYSKPFRDESTCUIVJFGLCOJ5RSPJREU6X2CIFGECTSDJFHEOLCUKJAUISKOI4WFGVCSIFKEKR2JIVJV6RKYKBGE6USFKIWFEQKOJNEU4R2TFRGUCUSLIVKF6TKPJZEVIT2S",
- "access-token": "tupYCgGeXK441+jaRX+owrVt1Rp2d+jBAvNoppf4XEB4puIgI2qW2keqByq7e4MqVIMJKTNtDtnVosMJMBmAMA==--uzF4yHkdKNh+M5urrosiVg==--P3I//V6qx7bxNlQhito1QA==",
- "data-access": "REAL_TIME",
- "display-name": "João",
- "versions": {
- "WEB_PWA_APP": "2.19.2"
}, - "days-to-expiration": 15,
- "default-portfólio": 16519,
- "minimum-version": 3,
- "datafeed-access-token": "np7ITttANtKQolkC1ys+FafO3KpGu2PT3ouUr1TA+0bwb7XrDYyRxX6UtP1S2L0df0qD1Cbx/NxUm6tUXtuVbQ==--mCOjry5sgY0l1ynDPeIFBQ==--ZKOM2Kp2aH3KWcX",
- "endpoints": [
- "wss://datafeed04.oplab.com.br"
], - "servers": [
- {
- "url": "wss://datafeed04.oplab.com.br",
- "level": 1
}
], - "system-config": {
- "routing-feature-activated": false
}
}Autoriza o acesso ao sistema a partir do token de acesso
| for | string Default: "default" Enum: "default" "chart" enumDescriptions: {"default":"Plataforma Oplab","chart":"Gráficos TradingView"} Contexto de autenticação |
| name | string Nome do usuário |
| id | integer ID do usuário dentro do OpLab |
object Configurações gerais da conta | |
string Email do usuário | |
| last-login | string <date-time> Data e hora do último login |
| category | string Categoria do plano do usuário |
| permissions | string Código de permissões do usuário |
| acl | string Código de permissões do plano do usuário |
| access-token | string Token de autenticação |
| data-access | string Enum: "REAL_TIME" "DELAYED" "EOD" Nível de acesso ao market data |
| display-name | string Nome do usuário que será mostrado na tela |
| avatar | string Link do gravatar com a imagem de perfil do usuário |
| versions | object Lista de aplicações e suas respecitivas versões |
| days-to-expiration | integer or null Indica os dias restantes do período de teste do usuário |
| default-portfólio | integer ID do portfólio padrão do usuário |
| minimum-version | integer Versão mínima da aplicação que o usuário tem acesso |
| phone-number | string Número do telefone do usuário |
| document-number | string Número do documento do usuário |
| datafeed-access-token | string Token de autenticação para o websocket, só existe se o parâmetro |
| endpoints | Array of strings Lista de URLs do websocket |
Array of objects Lista de servidores websocket | |
object Configurações gerais do sistema |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/users/authorize' \ -H 'Access-Token: {access-token}'
{- "name": "João da Silva",
- "id": 10518,
- "preferences": {
- "interest_rate_type": "SELIC",
- "interest_rate_value": 2.649873258040536,
- "broker": "OTHER",
- "brokerage_fee": 0.8,
- "order_amount": 1000,
- "simulate_price_strategy": "OPLAB",
- "position_price_strategy": [
- "BOOK",
- "OPLAB",
- "LAST",
- "THEORETICAL"
], - "simulate_with_brokerage_and_fees": true,
- "custom_perspective": [
- "bid",
- "ask"
], - "default_web_app_version": null,
- "tinted_moneyness": 10,
- "side_watchlist": true,
- "robot_limit": 10,
- "close_positions_automatically": false
}, - "last-login": "2019-03-26T00:35:02.243Z",
- "category": "MAX",
- "permissions": "ae1f55b1dd8fdd2f3ca49e82b544c513c787040e360fc2ed93df8ae11b64ee20",
- "acl": "KJCUCTC7KREU2RK7KFKUFRGVKTCUJFIEYRK7KBHVEV6VCFKMKFKIWFGVCVIREUKUZMKNEU2VKMIFKE6URMKNKFEQKUIVDUSRKTFRIE6UKESRSJINAVISKPJZJSYRSVJRGF6U2FKJEUKUZMJBEVGVCPKJEUGQKML5WFAUSPJVHV6Q2VKNKE6TGUCUSLIVKF6RCBKRASYSCJKNKE6USJINAUYX2PKBCVEQKUJFHU4UZMKBHVEVCGJ5GEST27JVAU4QKHIVGUKTSUCGJ5GEST2TFRIE6V2EIVJFGLCQJ5JFISUIZHUYSKPFRDESTCUIVJFGLCOJ5RSPJREU6X2CIFGECTSDJFHEOLCUKJAUISKOI4WFGVCSIFKEKR2JIVJV6RKYKBGE6USFKIWFEQKOJNEU4R2TFRGUCUSLIVKF6TKPJZEVIT2S",
- "access-token": "tupYCgGeXK441+jaRX+owrVt1Rp2d+jBAvNoppf4XEB4puIgI2qW2keqByq7e4MqVIMJKTNtDtnVosMJMBmAMA==--uzF4yHkdKNh+M5urrosiVg==--P3I//V6qx7bxNlQhito1QA==",
- "data-access": "REAL_TIME",
- "display-name": "João",
- "versions": {
- "WEB_PWA_APP": "2.19.2"
}, - "days-to-expiration": 15,
- "default-portfólio": 16519,
- "minimum-version": 3,
- "datafeed-access-token": "np7ITttANtKQolkC1ys+FafO3KpGu2PT3ouUr1TA+0bwb7XrDYyRxX6UtP1S2L0df0qD1Cbx/NxUm6tUXtuVbQ==--mCOjry5sgY0l1ynDPeIFBQ==--ZKOM2Kp2aH3KWcX",
- "endpoints": [
- "wss://datafeed04.oplab.com.br"
], - "servers": [
- {
- "url": "wss://datafeed04.oplab.com.br",
- "level": 1
}
], - "system-config": {
- "routing-feature-activated": false
}
}Obtém a lista de configurações do usuário
| group | string Enum: "admin" "producer" Example: group=admin,producer Grupo das configurações a serem filtradas na consulta. Aceita mais de um valor, separando por vírgula |
| logo | string Imagem do logotipo codificada como Data URL |
| color | string Cor principal |
| text | string Texto padrão |
| interest_rate_type | string Enum: "CETIP" "SELIC" "OTHER" Tipo da taxa que será utilizada nas simulações |
| interest_rate_value | number Valor da taxa que será utilizada nas simulações, editável quando o tipo selecionado for |
| broker | string Value: "OTHER" Corretora utilizada pelo usuário |
| brokerage_fee | number Taxa da corretora que será utilizada nas simulações, editável quando a corretora selecionada for |
| order_amount | integer Quantidade de ativos que será utilizada nas simulações |
| simulate_price_strategy | string Enum: "BOOK" "LAST" "THEORETICAL" "OPLAB" Estratégia de preço para cálculo das simulações |
| position_price_strategy | Array of strings Items Enum: "BOOK" "LAST" "THEORETICAL" "OPLAB" Ordem de priorização do preço que será utilizado para cálculos quando o mercado estiver fechado |
| simulate_with_brokerage_and_fees | boolean Indica se os valores de corretagem serão utilizados nas simulações |
| custom_perspective | Array of strings <= 11 Items Enum: "symbol" "bid" "ask" "mid" "vol" … 28 more Lista de colunas que serão exibidas na perspectiva customizada da tela de análise |
| default_web_app_version | number or null Versão da plataforma favorita do usuário |
| tinted_moneyness | integer [ 0 .. 50 ] Intensidade da coloração de ITM e OTM na plataforma |
| side_watchlist | boolean Indica se a barra lateral com as watchlists será exibida |
| robot_limit | integer Limite máximo de robôs que o usuário pode ter em execução |
| close_positions_automatically | boolean Indica se a plataforma deve fechar (criar uma contra-ordem simulada) as posições automaticamente ao final do dia de vencimento |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/users/settings' \ -H 'Access-Token: {access-token}'
{- "logo": "data:<mediatype>;base64,<data>",
- "color": "#FFFFFF",
- "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin porttitor ut nulla nec blandit. Vivamus eu enim et elit imperdiet ullamcorper nec id justo. Sed et vestibulum lorem, ut euismod ante. Sed eu elementum augue, eu egestas lectus. Nam enim quam, viverra eu quam et, lacinia vulputate sem. Pellentesque lacinia gravida placerat. Nullam erat purus, mattis non dui vel, ultricies malesuada arcu. Ut dictum neque eget nulla volutpat, ac maximus purus malesuada. Proin quis ligula semper, tincidunt odio et, aliquet nulla.",
- "interest_rate_type": "SELIC",
- "interest_rate_value": 2.649873258040536,
- "broker": "OTHER",
- "brokerage_fee": 0.8,
- "order_amount": 1000,
- "simulate_price_strategy": "OPLAB",
- "position_price_strategy": [
- "BOOK",
- "OPLAB",
- "LAST",
- "THEORETICAL"
], - "simulate_with_brokerage_and_fees": true,
- "custom_perspective": [
- "bid",
- "ask"
], - "default_web_app_version": null,
- "tinted_moneyness": 10,
- "side_watchlist": true,
- "robot_limit": 10,
- "close_positions_automatically": false
}Atualiza as configurações gerais da conta do usuário, com exceção de permissões administrativas
| preferences required | string Configurações gerais do usuário |
{- "preferences": "{\"interest_rate_type\": \"SELIC\", \"interest_rate_value\": 2.649873258040536, \"broker\": \"OTHER\", \"brokerage_fee\": 0.8, \"order_amount\": 1000, \"simulate_price_strategy\": \"LAST\", \"position_price_strategy\": [\"BOOK\",\"LAST\",\"THEORETICAL\"], \"simulate_with_brokerage_and_fees\": true, \"custom_perspective\": [\"bid\",\"ask\"], \"default_web_app_version\": null, \"tinted_moneyness\": 10, \"side_watchlist\": true, \"robot_limit\": 10, \"close_positions_automatically\": false}"
}Altera e retorna as configurações de publicação do usuário
| logo | string Imagem do logotipo codificada como Data URL |
| color | string Cor principal |
| text | string Texto padrão |
| logo | string Imagem do logotipo codificada como Data URL |
| color | string Cor principal |
| text | string Texto padrão |
{- "logo": "data:<mediatype>;base64,<data>",
- "color": "#FFFFFF",
- "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin porttitor ut nulla nec blandit. Vivamus eu enim et elit imperdiet ullamcorper nec id justo. Sed et vestibulum lorem, ut euismod ante. Sed eu elementum augue, eu egestas lectus. Nam enim quam, viverra eu quam et, lacinia vulputate sem. Pellentesque lacinia gravida placerat. Nullam erat purus, mattis non dui vel, ultricies malesuada arcu. Ut dictum neque eget nulla volutpat, ac maximus purus malesuada. Proin quis ligula semper, tincidunt odio et, aliquet nulla."
}{- "logo": "data:<mediatype>;base64,<data>",
- "color": "#FFFFFF",
- "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin porttitor ut nulla nec blandit. Vivamus eu enim et elit imperdiet ullamcorper nec id justo. Sed et vestibulum lorem, ut euismod ante. Sed eu elementum augue, eu egestas lectus. Nam enim quam, viverra eu quam et, lacinia vulputate sem. Pellentesque lacinia gravida placerat. Nullam erat purus, mattis non dui vel, ultricies malesuada arcu. Ut dictum neque eget nulla volutpat, ac maximus purus malesuada. Proin quis ligula semper, tincidunt odio et, aliquet nulla."
}Altera os dados do usuário
| id required | integer ID do usuário |
| name | string Nome do usuário |
| document_type | string Default: "CPF" Enum: "CPF" "CNPJ" "Passport" Tipo de documento que será informado |
| document_number | string Número do documento do usuário |
| phone_area_code | string DDD do telefone |
| phone_number | string Número do telefone |
{- "name": "João",
- "document_type": "CPF",
- "document_number": "12345678900",
- "phone_area_code": "11",
- "phone_number": "12345678"
}{- "error": "string"
}Lista todos os usuários do tipo consultor de investimentos
| id | integer ID do usuário |
| name | string Nome do usuário |
string <email> E-mail do usuário |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/users/advisors' \ -H 'Access-Token: {access-token}'
[
]Obtém uma lista com todos os portfólios do usuário
| id | integer ID do portfólio |
| user_id | integer ID do usuário |
| created_at | string <date-time> Data em que o portfólio foi criado |
| updated_at | string <date-time> Data da última alteração do portfólio |
| active | boolean Indica se o portfólio está ativo |
| name | string <nullable> Nome do portfólio |
| is_default | boolean Indica se é o portfólio padrão do usuário |
Array of OptionPosition (object) or StockOrBondPosition (object) Lista com as posições do portfólio | |
| balancings | Array of strings Lista com os balanceamentos do portfólio |
| is_shared | boolean Indica se o portfólio é compartilhado |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios' \ -H 'Access-Token: {access-token}'
[- {
- "id": 16519,
- "user_id": 10518,
- "created_at": "2020-06-21T18:23:35.238-03:00",
- "updated_at": "2020-06-21T18:23:35.238-03:00",
- "active": true,
- "name": "Meu portfólio",
- "is_default": true,
- "positions": [
- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 1,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
], - "balancings": [ ],
- "is_shared": false
}
]Inclui um novo portfólio vazio na conta do usuário
| name | string Nome do portfólio |
| active | boolean Indica se o portfólio está ativo |
| id | integer ID do portfólio |
| user_id | integer ID do usuário |
| created_at | string <date-time> Data em que o portfólio foi criado |
| updated_at | string <date-time> Data da última alteração do portfólio |
| active | boolean Indica se o portfólio está ativo |
| name | string <nullable> Nome do portfólio |
| is_default | boolean Indica se é o portfólio padrão do usuário |
Array of OptionPosition (object) or StockOrBondPosition (object) Lista com as posições do portfólio | |
| balancings | Array of strings Lista com os balanceamentos do portfólio |
| is_shared | boolean Indica se o portfólio é compartilhado |
{- "name": "Novo portfólio",
- "active": true
}{- "id": 16519,
- "user_id": 10518,
- "created_at": "2020-06-21T18:23:35.238-03:00",
- "updated_at": "2020-06-21T18:23:35.238-03:00",
- "active": true,
- "name": "Meu portfólio",
- "is_default": true,
- "positions": [
- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 1,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
], - "balancings": [ ],
- "is_shared": false
}Obtém um objeto com os dados do portfólio especificado
| id required | integer ID do portfólio |
| id | integer ID do portfólio |
| user_id | integer ID do usuário |
| created_at | string <date-time> Data em que o portfólio foi criado |
| updated_at | string <date-time> Data da última alteração do portfólio |
| active | boolean Indica se o portfólio está ativo |
| name | string <nullable> Nome do portfólio |
| is_default | boolean Indica se é o portfólio padrão do usuário |
Array of OptionPosition (object) or StockOrBondPosition (object) Lista com as posições do portfólio | |
| balancings | Array of strings Lista com os balanceamentos do portfólio |
| is_shared | boolean Indica se o portfólio é compartilhado |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 16519,
- "user_id": 10518,
- "created_at": "2020-06-21T18:23:35.238-03:00",
- "updated_at": "2020-06-21T18:23:35.238-03:00",
- "active": true,
- "name": "Meu portfólio",
- "is_default": true,
- "positions": [
- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 1,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
], - "balancings": [ ],
- "is_shared": false
}Altera os dados do portfólio especificado
| id required | integer ID do portfólio |
| name | string Nome do portfólio |
| active | boolean Indica se o portfólio está ativo |
| id | integer ID do portfólio |
| user_id | integer ID do usuário |
| created_at | string <date-time> Data em que o portfólio foi criado |
| updated_at | string <date-time> Data da última alteração do portfólio |
| active | boolean Indica se o portfólio está ativo |
| name | string <nullable> Nome do portfólio |
| is_default | boolean Indica se é o portfólio padrão do usuário |
Array of OptionPosition (object) or StockOrBondPosition (object) Lista com as posições do portfólio | |
| balancings | Array of strings Lista com os balanceamentos do portfólio |
| is_shared | boolean Indica se o portfólio é compartilhado |
{- "name": "Novo portfólio",
- "active": true
}{- "id": 16519,
- "user_id": 10518,
- "created_at": "2020-06-21T18:23:35.238-03:00",
- "updated_at": "2020-06-21T18:23:35.238-03:00",
- "active": true,
- "name": "Meu portfólio",
- "is_default": true,
- "positions": [
- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 1,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
], - "balancings": [ ],
- "is_shared": false
}Obtém uma lista com os dados de retorno do portfólio especificado
| id required | integer ID do portfólio |
| from | string <date-time> Example: from=20210305 Data de início da consulta |
| to | string <date-time> Example: to=20210505 Data de fim da consulta |
| time | string <date> Data de referência |
| total_purchases | number Total financeiro de compra |
| total_sales | number Total financeiro de venda |
| balance | number Balanço financeiro |
| acc_balance | number Balanço financeiro acumulado |
| mtm | number Valor a mercado considerando todas as posições do portfólio |
| return | number Taxa de retorno |
| xirr | number Taxa interna de retorno. Cálculo ainda não implementado |
| warranty | number Caixa do dia |
| acc_warranty | number Caixa acumulado |
| pnl | number Retorno financeiro absoluto |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{id}/returns?from={from}&to={to}' \ -H 'Access-Token: {access-token}'
[- {
- "time": "2021-09-20",
- "total_purchases": 117059,
- "total_sales": 1120063,
- "balance": 1003004,
- "acc_balance": 2024864,
- "mtm": 70924.2,
- "return": 41.915764,
- "xirr": 0,
- "warranty": 1000,
- "acc_warranty": 50000,
- "pnl": 120924.2
}
]Obtém uma lista das tags associadas ao portfólio especificado
| id required | integer ID do portfólio |
Tags associadas. Tags com prefixo '$' são associadas na criação das posições
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{id}/tags' \ -H 'Access-Token: {access-token}'
[- "$shares",
- "$stock",
- "$staged"
]Habilita a sincronização do portfólio especificado com uma fonte de dados
| id required | integer ID do portfólio |
| sync_strategy | string Value: "b3" Nome da fonte de dados |
| link | string Link para o usuário autorizar a sincronização na fonte de dados |
{- "sync_strategy": "b3"
}{
}Desabilita a sincronização do portfólio especificado
| id required | integer ID do portfólio |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/portfolios/{id}/synchronize' \ -H 'Access-Token: {access-token}'
Obtém uma lista com todas as estratégias do portfólio especificado
| portfolio_id required | integer ID do portfólio |
| status | string Default: "open" Enum: "open" "all" Status das posições da estratégia a serem listadas |
| id | integer ID da estratégia |
| name | string or null Nome da estratégia |
| created_at | string <date-time> Data que a estratégia foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
| user_id | integer ID do usuário |
| underlying | string Código de negociação do ativo alvo |
| published_at | string or null <date-time> Data que a estratégia deve ser publicada |
| expired_at | string or null <date-time> Data que a estratégia deve ser expirada |
| short_description | string or null Descrição resumida da estratégia |
| description | string or null Descrição completa da estratégia |
Array of OptionPositionStrategy (object) or StockOrBondPositionStrategy (object) Posições relacionadas à estratégia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/strategies?status={status}' \ -H 'Access-Token: {access-token}'
[- {
- "id": 2502,
- "name": "Venda coberta",
- "created_at": "2021-06-30T17:07:21.640-03:00",
- "updated_at": "2021-06-30T17:07:21.640-03:00",
- "user_id": 10518,
- "underlying": "ABEV3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null,
- "positions": [
- {
- "id": 41999,
- "portfolio_id": 16519,
- "amount": -100,
- "average_price": 0.41,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "balance": {
- "initial": 41,
- "realized": 0,
- "current": 41
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "AMBEV S/A ON R$ 18.50 20-08-2021",
- "symbol": "ABEVH185",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "ABEV3",
- "name": "AMBEV S/A ON",
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 55,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": false
}, - "market": {
- "open": 0.5,
- "high": 0.54,
- "low": 0.42,
- "close": 0.44,
- "vol": 210600,
- "fin_volume": 96362,
- "trades": 0,
- "bid": 0.41,
- "ask": 0.55,
- "variation": -16.981,
- "previous_close": 0.51
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 36,
- "due_date": "2021-08-20",
- "strike": 18.5,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.43
}, - "quant": null,
- "staged": true
}, - {
- "id": 41998,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 17.08,
- "weight": 0,
- "tags": [
- "$stock",
- "$staged",
- "$shares"
], - "balance": {
- "initial": -1708,
- "realized": 0,
- "current": -1708
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "AMBEV S/A ON",
- "symbol": "ABEV3",
- "robots": [ ],
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 50,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": true
}
]
}
]Inclui uma estratégia no portfólio especificado
| portfolio_id required | integer ID do portfólio |
| name | string or null Nome da estratégia |
| underlying | string Código de negociação do ativo alvo |
| origin | string Default: "simulator" Enum: "simulator" "order_ticket" Origem da estratégia |
Array of objects Posições relacionadas à estratégia | |
| published_at | string <date-time> Data que a estratégia deve ser publicada. Campo válido apenas para estratégias que serão publicadas |
| expired_at | string <date-time> Data que a estratégia deve ser expirada. Campo válido apenas para estratégias que serão publicadas |
| short_description | string <= 144 Descrição resumida da estratégia. Campo válido apenas para estratégias que serão publicadas |
| description | string Descrição completa da estratégia. Campo válido apenas para estratégias que serão publicadas |
| id | integer ID da estratégia |
| name | string or null Nome da estratégia |
| created_at | string <date-time> Data que a estratégia foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
| user_id | integer ID do usuário |
| underlying | string Código de negociação do ativo alvo |
| published_at | string or null <date-time> Data que a estratégia deve ser publicada |
| expired_at | string or null <date-time> Data que a estratégia deve ser expirada |
| short_description | string or null Descrição resumida da estratégia |
| description | string or null Descrição completa da estratégia |
Array of OptionDetailedPosition (object) or StockOrBondDetailedPosition (object) Posições relacionadas à estratégia |
{- "name": "Venda coberta",
- "underlying": "ABEV3",
- "origin": "order_ticket",
- "positions": [
- {
- "symbol": "ABEV3",
- "amount": 100,
- "side": "BUY",
- "price": 17.08
}
], - "published_at": "2023-07-07",
- "expired_at": "2023-07-13",
- "short_description": "Teste",
- "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin porttitor ut nulla nec blandit. Vivamus eu enim et elit imperdiet ullamcorper nec id justo. Sed et vestibulum lorem, ut euismod ante. Sed eu elementum augue, eu egestas lectus. Nam enim quam, viverra eu quam et, lacinia vulputate sem. Pellentesque lacinia gravida placerat. Nullam erat purus, mattis non dui vel, ultricies malesuada arcu. Ut dictum neque eget nulla volutpat, ac maximus purus malesuada. Proin quis ligula semper, tincidunt odio et, aliquet nulla."
}{- "id": 2502,
- "name": "Venda coberta",
- "created_at": "2021-09-17T19:33:00.568-03:00",
- "updated_at": "2021-09-17T19:33:00.568-03:00",
- "user_id": 10518,
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null,
- "positions": [
- {
- "id": 41999,
- "portfolio_id": 16519,
- "amount": -100,
- "average_price": 0.44,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2943,
- "name": "Venda coberta",
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": 44,
- "realized": 0,
- "current": 44
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "PETROBRAS ON, R$ 27.60, 15-10-2021",
- "symbol": "PETRJ292",
- "underlying_asset": {
- "symbol": "PETR3",
- "name": "PETROBRAS ON",
- "market": {
- "open": 26.61,
- "high": 26.7,
- "low": 25.5,
- "close": 25.5,
- "vol": 31631800,
- "fin_volume": 814374000,
- "trades": 0,
- "bid": 25.5,
- "ask": 25.58,
- "variation": -4.57,
- "previous_close": 26.66
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 99.62,
- "min": 25.04,
- "percentile": 40.08,
- "ranking": 15.19
}, - "six_m": {
- "max": 68.97,
- "min": 25.04,
- "percentile": 34.92,
- "ranking": 25.8
}, - "current": 36.37
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 36.9,
- "ranking": 18.73
}, - "six_m": {
- "max": 54.58,
- "min": 27.47,
- "percentile": 59.52,
- "ranking": 18.73
}, - "current": 37.31
}, - "stdv": {
- "one_y": 0.028357509569702094,
- "five_d": 0.014712573982026368
}, - "trend": {
- "middle_term": 0,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.03,
- "beta_ibov": 1.5467319145261378,
- "correl_ibov": 0.7139516613616521
}, - "staged": false
}, - "market": {
- "open": 0.58,
- "high": 0.58,
- "low": 0.44,
- "close": 0.46,
- "vol": 53300,
- "fin_volume": 25456,
- "trades": 0,
- "bid": 0,
- "ask": 0,
- "variation": -42.5,
- "previous_close": 0.65
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 19,
- "due_date": "2021-10-15",
- "strike": 27.6,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 25.41
}, - "quant": null,
- "staged": true,
- "orders": [
- {
- "id": 18504,
- "order_type": "manual",
- "action": 1,
- "amount": 100,
- "price": 0.44,
- "status": "staged",
- "created_at": "2021-09-17T19:33:00.636-03:00",
- "updated_at": "2021-09-17T19:33:00.636-03:00",
- "brokerage": null,
- "symbol": "PETRJ292",
- "expires_at": null,
- "executed_at": "2021-09-17T19:33:00.636-03:00",
- "trigger_price": null,
- "target_price": 0.44,
- "target_amount": 100,
- "origin": "simulator",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "SELL",
- "trading_account": null
}
]
}, - {
- "id": 41998,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 25.5,
- "weight": 0,
- "tags": [
- "$stock",
- "$staged",
- "$shares"
], - "strategy": {
- "id": 2943,
- "name": "Venda coberta",
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -2550,
- "realized": 0,
- "current": -2550
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "market": {
- "open": 26.61,
- "high": 26.7,
- "low": 25.5,
- "close": 25.5,
- "vol": 31631800,
- "fin_volume": 814374000,
- "trades": 0,
- "bid": 25.58,
- "ask": 25.5,
- "variation": -4.57,
- "previous_close": 26.66
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 99.62,
- "min": 25.04,
- "percentile": 40.08,
- "ranking": 15.19
}, - "six_m": {
- "max": 68.97,
- "min": 25.04,
- "percentile": 34.92,
- "ranking": 25.8
}, - "current": 36.37
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 36.9,
- "ranking": 18.73
}, - "six_m": {
- "max": 54.58,
- "min": 27.47,
- "percentile": 59.52,
- "ranking": 18.73
}, - "current": 37.31
}, - "stdv": {
- "one_y": 0.028357509569702094,
- "five_d": 0.014712573982026368
}, - "trend": {
- "middle_term": 0,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.03,
- "beta_ibov": 1.5467319145261378,
- "correl_ibov": 0.7139516613616521
}, - "staged": true,
- "orders": [
- {
- "id": 18503,
- "order_type": "manual",
- "action": -1,
- "amount": 100,
- "price": 25.5,
- "status": "staged",
- "created_at": "2021-09-17T19:33:00.573-03:00",
- "updated_at": "2021-09-17T19:33:00.573-03:00",
- "brokerage": null,
- "symbol": "PETR3",
- "expires_at": null,
- "executed_at": "2021-09-17T19:33:00.573-03:00",
- "trigger_price": null,
- "target_price": 25.5,
- "target_amount": 100,
- "origin": "simulator",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "trading_account": null
}
]
}
]
}Obtém um objeto com os dados da estratégia especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da estratégia |
| id | integer ID da estratégia |
| name | string or null Nome da estratégia |
| created_at | string <date-time> Data que a estratégia foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
| user_id | integer ID do usuário |
| underlying | string Código de negociação do ativo alvo |
| published_at | string or null <date-time> Data que a estratégia deve ser publicada |
| expired_at | string or null <date-time> Data que a estratégia deve ser expirada |
| short_description | string or null Descrição resumida da estratégia |
| description | string or null Descrição completa da estratégia |
Array of OptionPositionStrategy (object) or StockOrBondPositionStrategy (object) Posições relacionadas à estratégia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/strategies/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 2502,
- "name": "Venda coberta",
- "created_at": "2021-06-30T17:07:21.640-03:00",
- "updated_at": "2021-06-30T17:07:21.640-03:00",
- "user_id": 10518,
- "underlying": "ABEV3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null,
- "positions": [
- {
- "id": 41999,
- "portfolio_id": 16519,
- "amount": -100,
- "average_price": 0.41,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "balance": {
- "initial": 41,
- "realized": 0,
- "current": 41
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "AMBEV S/A ON R$ 18.50 20-08-2021",
- "symbol": "ABEVH185",
- "underlying_asset": {
- "symbol": "ABEV3",
- "name": "AMBEV S/A ON",
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 55,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": false
}, - "market": {
- "open": 0.5,
- "high": 0.54,
- "low": 0.42,
- "close": 0.44,
- "vol": 210600,
- "fin_volume": 96362,
- "trades": 0,
- "bid": 0.41,
- "ask": 0.55,
- "variation": -16.981,
- "previous_close": 0.51
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 36,
- "due_date": "2021-08-20",
- "strike": 18.5,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.43
}, - "quant": null,
- "staged": true
}, - {
- "id": 41998,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 17.08,
- "weight": 0,
- "tags": [
- "$stock",
- "$staged",
- "$shares"
], - "balance": {
- "initial": -1708,
- "realized": 0,
- "current": -1708
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "AMBEV S/A ON",
- "symbol": "ABEV3",
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 50,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": true
}
]
}Remove uma estratégia do portfólio especificado
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da estratégia |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/strategies/{id}' \ -H 'Access-Token: {access-token}'
{- "error": "string"
}Renomeia a estratégia especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da estratégia |
| name | string Novo nome da estratégia |
| id | integer ID da estratégia |
| name | string or null Nome da estratégia |
| created_at | string <date-time> Data que a estratégia foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
| user_id | integer ID do usuário |
| underlying | string Código de negociação do ativo alvo |
| published_at | string or null <date-time> Data que a estratégia deve ser publicada |
| expired_at | string or null <date-time> Data que a estratégia deve ser expirada |
| short_description | string or null Descrição resumida da estratégia |
| description | string or null Descrição completa da estratégia |
Array of OptionPositionStrategy (object) or StockOrBondPositionStrategy (object) Posições relacionadas à estratégia |
{- "name": "Estratégia renomeada"
}{- "id": 2502,
- "name": "Venda coberta",
- "created_at": "2021-06-30T17:07:21.640-03:00",
- "updated_at": "2021-06-30T17:07:21.640-03:00",
- "user_id": 10518,
- "underlying": "ABEV3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null,
- "positions": [
- {
- "id": 41999,
- "portfolio_id": 16519,
- "amount": -100,
- "average_price": 0.41,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "balance": {
- "initial": 41,
- "realized": 0,
- "current": 41
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "AMBEV S/A ON R$ 18.50 20-08-2021",
- "symbol": "ABEVH185",
- "underlying_asset": {
- "symbol": "ABEV3",
- "name": "AMBEV S/A ON",
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 55,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": false
}, - "market": {
- "open": 0.5,
- "high": 0.54,
- "low": 0.42,
- "close": 0.44,
- "vol": 210600,
- "fin_volume": 96362,
- "trades": 0,
- "bid": 0.41,
- "ask": 0.55,
- "variation": -16.981,
- "previous_close": 0.51
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 36,
- "due_date": "2021-08-20",
- "strike": 18.5,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.43
}, - "quant": null,
- "staged": true
}, - {
- "id": 41998,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 17.08,
- "weight": 0,
- "tags": [
- "$stock",
- "$staged",
- "$shares"
], - "balance": {
- "initial": -1708,
- "realized": 0,
- "current": -1708
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "AMBEV S/A ON",
- "symbol": "ABEV3",
- "market": {
- "open": 17.15,
- "high": 17.46,
- "low": 17.02,
- "close": 17.08,
- "vol": 28949400,
- "fin_volume": 496857000,
- "trades": 0,
- "bid": 17.08,
- "ask": 17.1,
- "variation": -1.215,
- "previous_close": 17.28
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 49.76,
- "min": 31.3,
- "percentile": 12.7,
- "ranking": 7.75
}, - "six_m": {
- "max": 41.8,
- "min": 31.3,
- "percentile": 25.4,
- "ranking": 13.62
}, - "current": 32.73
}, - "iv": {
- "one_y": {
- "max": 49.28,
- "min": 23.66,
- "percentile": 48.81,
- "ranking": 49.76580796252925
}, - "six_m": {
- "max": 43.9,
- "min": 23.66,
- "percentile": 61.11,
- "ranking": 62.99407114624504
}, - "current": 36.41
}, - "stdv": {
- "one_y": 0.021461612671602417,
- "five_d": 0.02862693934680497
}, - "trend": {
- "middle_term": 0,
- "short_term": -1
}, - "positive_scenario_probability": 50,
- "semi_return": 1,
- "beta_ibov": 1.0023739766296522,
- "correl_ibov": 0.6269554866764695
}, - "staged": true
}
]
}Consolida e retorna uma lista com os dados das posições da estratégia especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da estratégia |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
curl -i -X PUT \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/strategies/{id}/commit' \ -H 'Access-Token: {access-token}'
{- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}Fecha as posições da estratégia especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da estratégia |
| exercise | Array of integers IDs da posições a serem exercidas |
| id | integer ID da estratégia |
| name | string or null Nome da estratégia |
| created_at | string <date-time> Data que a estratégia foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
| user_id | integer ID do usuário |
| underlying | string Código de negociação do ativo alvo |
| published_at | string or null <date-time> Data que a estratégia deve ser publicada |
| expired_at | string or null <date-time> Data que a estratégia deve ser expirada |
| short_description | string or null Descrição resumida da estratégia |
| description | string or null Descrição completa da estratégia |
Array of OptionDetailedPosition (object) or StockOrBondDetailedPosition (object) Posições relacionadas à estratégia |
{- "exercise": [
- 41998,
- 41999
]
}{- "id": 2502,
- "name": "Venda coberta",
- "created_at": "2021-09-17T19:33:00.568-03:00",
- "updated_at": "2021-09-17T19:33:00.568-03:00",
- "user_id": 10518,
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null,
- "positions": [
- {
- "id": 41999,
- "portfolio_id": 16519,
- "amount": -100,
- "average_price": 0.44,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2943,
- "name": "Venda coberta",
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": 44,
- "realized": 0,
- "current": 44
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "PETROBRAS ON, R$ 27.60, 15-10-2021",
- "symbol": "PETRJ292",
- "underlying_asset": {
- "symbol": "PETR3",
- "name": "PETROBRAS ON",
- "market": {
- "open": 26.61,
- "high": 26.7,
- "low": 25.5,
- "close": 25.5,
- "vol": 31631800,
- "fin_volume": 814374000,
- "trades": 0,
- "bid": 25.5,
- "ask": 25.58,
- "variation": -4.57,
- "previous_close": 26.66
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 99.62,
- "min": 25.04,
- "percentile": 40.08,
- "ranking": 15.19
}, - "six_m": {
- "max": 68.97,
- "min": 25.04,
- "percentile": 34.92,
- "ranking": 25.8
}, - "current": 36.37
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 36.9,
- "ranking": 18.73
}, - "six_m": {
- "max": 54.58,
- "min": 27.47,
- "percentile": 59.52,
- "ranking": 18.73
}, - "current": 37.31
}, - "stdv": {
- "one_y": 0.028357509569702094,
- "five_d": 0.014712573982026368
}, - "trend": {
- "middle_term": 0,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.03,
- "beta_ibov": 1.5467319145261378,
- "correl_ibov": 0.7139516613616521
}, - "staged": false
}, - "market": {
- "open": 0.58,
- "high": 0.58,
- "low": 0.44,
- "close": 0.46,
- "vol": 53300,
- "fin_volume": 25456,
- "trades": 0,
- "bid": 0,
- "ask": 0,
- "variation": -42.5,
- "previous_close": 0.65
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 19,
- "due_date": "2021-10-15",
- "strike": 27.6,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 25.41
}, - "quant": null,
- "staged": true,
- "orders": [
- {
- "id": 18504,
- "order_type": "manual",
- "action": 1,
- "amount": 100,
- "price": 0.44,
- "status": "staged",
- "created_at": "2021-09-17T19:33:00.636-03:00",
- "updated_at": "2021-09-17T19:33:00.636-03:00",
- "brokerage": null,
- "symbol": "PETRJ292",
- "expires_at": null,
- "executed_at": "2021-09-17T19:33:00.636-03:00",
- "trigger_price": null,
- "target_price": 0.44,
- "target_amount": 100,
- "origin": "simulator",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "SELL",
- "trading_account": null
}
]
}, - {
- "id": 41998,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 25.5,
- "weight": 0,
- "tags": [
- "$stock",
- "$staged",
- "$shares"
], - "strategy": {
- "id": 2943,
- "name": "Venda coberta",
- "underlying": "PETR3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -2550,
- "realized": 0,
- "current": -2550
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "market": {
- "open": 26.61,
- "high": 26.7,
- "low": 25.5,
- "close": 25.5,
- "vol": 31631800,
- "fin_volume": 814374000,
- "trades": 0,
- "bid": 25.58,
- "ask": 25.5,
- "variation": -4.57,
- "previous_close": 26.66
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 99.62,
- "min": 25.04,
- "percentile": 40.08,
- "ranking": 15.19
}, - "six_m": {
- "max": 68.97,
- "min": 25.04,
- "percentile": 34.92,
- "ranking": 25.8
}, - "current": 36.37
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 36.9,
- "ranking": 18.73
}, - "six_m": {
- "max": 54.58,
- "min": 27.47,
- "percentile": 59.52,
- "ranking": 18.73
}, - "current": 37.31
}, - "stdv": {
- "one_y": 0.028357509569702094,
- "five_d": 0.014712573982026368
}, - "trend": {
- "middle_term": 0,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.03,
- "beta_ibov": 1.5467319145261378,
- "correl_ibov": 0.7139516613616521
}, - "staged": true,
- "orders": [
- {
- "id": 18503,
- "order_type": "manual",
- "action": -1,
- "amount": 100,
- "price": 25.5,
- "status": "staged",
- "created_at": "2021-09-17T19:33:00.573-03:00",
- "updated_at": "2021-09-17T19:33:00.573-03:00",
- "brokerage": null,
- "symbol": "PETR3",
- "expires_at": null,
- "executed_at": "2021-09-17T19:33:00.573-03:00",
- "trigger_price": null,
- "target_price": 25.5,
- "target_amount": 100,
- "origin": "simulator",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "trading_account": null
}
]
}
]
}Obtém uma lista com as posições do portfólio especificado
| portfolio_id required | integer ID do portfólio |
| status | string Default: "open" Enum: "open" "closed" "all" Status das posições a serem listadas |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions?status={status}' \ -H 'Access-Token: {access-token}'
[- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
]Obtém um objeto com os dados da posição especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}Altera os dados da posição especificada, podendo move-la para outra estratégia (nova ou existente)
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| name | string Nome da posição |
| positive_scenario_probability | number Taxa de probabilidade de lucro |
| strategy_id | integer ID da estratégia para associar a posição, quando nulo será criada uma nova estratégia |
| strategy_name | string Nome da nova estratégia para associar a posição |
| orders | Array of integers IDs das ordens que serão movidas para a estratégia, quando nulo todas as ordens serão movidas |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
{- "name": "Exemplo",
- "positive_scenario_probability": 10,
- "strategy_id": 1,
- "strategy_name": "Estratégia nova",
- "orders": [
- 100,
- 101
]
}[- {
- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}
]Remove os dados da posição especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{id}' \ -H 'Access-Token: {access-token}'
{- "error": "string"
}Inclui uma determinada tag na posição especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| tag required | string Tag a ser incluida |
curl -i -X PUT \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{id}/tag/{tag}' \ -H 'Access-Token: {access-token}'
Remove uma determinada tag da posição especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| tag required | string Tag a ser removida |
curl -i -X PUT \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{id}/untag/{tag}' \ -H 'Access-Token: {access-token}'
Consolida uma posição simulada especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
curl -i -X PUT \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{id}/commit' \ -H 'Access-Token: {access-token}'
{- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}Altera o status da posição especificada para fechada enviando uma contra-ordem
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da posição |
| exercise | boolean Indica se a posição será exercida |
| id | integer ID da posição |
| portfolio_id | integer ID do portfólio |
| amount | number Quantidade de ativos |
| average_price | number Preço médio de compra/venda |
| weight | number Peso da posição no portfólio |
| tags | Array of strings Tags associadas a posição |
object or null Estratégia que a posição está associada | |
object Balanço financeiro da posição | |
| exchange | string Enum: "BCB" "BOVESPA" Sigla da responsável pela negociação |
| type | string Value: "option" Tipo de ativo |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| symbol | string Código de negociação da opção |
Array of objects | |
object Informações do ativo alvo | |
object Informações de mercado da opção | |
object Informações gerais da opção | |
| quant | null Informações quantitativas |
| staged | boolean Indica se é uma posição simulada |
{- "exercise": true
}{- "id": 41816,
- "portfolio_id": 16519,
- "amount": 100,
- "average_price": 1.25,
- "weight": 0,
- "tags": [
- "$option",
- "$staged",
- "CALL",
- "$option_on_equities"
], - "strategy": {
- "id": 2881,
- "name": "Compra de opções de compra a seco",
- "underlying": "B3SA3",
- "published_at": null,
- "expired_at": null,
- "short_description": null,
- "description": null
}, - "balance": {
- "initial": -125,
- "realized": 0,
- "current": -125
}, - "exchange": "BOVESPA",
- "type": "option",
- "name": "B3 ON R$ 16.37 16-07-2021",
- "symbol": "B3SAG501",
- "robots": [ ],
- "underlying_asset": {
- "symbol": "B3SA3",
- "name": "B3 ON",
- "market": {
- "open": 16.9,
- "high": 17.22,
- "low": 16.9,
- "close": 17.01,
- "vol": 30573600,
- "fin_volume": 521397000,
- "trades": 0,
- "bid": 17.01,
- "ask": 17.03,
- "variation": 0.118,
- "previous_close": 16.98
}, - "info": {
- "category": null,
- "contract_size": 1,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 63.31,
- "min": 32.35,
- "percentile": 1.98,
- "ranking": 0.82
}, - "six_m": {
- "max": 47.27,
- "min": 32.35,
- "percentile": 3.97,
- "ranking": 1.7
}, - "current": 32.61
}, - "iv": {
- "one_y": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 3.97,
- "ranking": 13.277249451353326
}, - "six_m": {
- "max": 54.51,
- "min": 27.17,
- "percentile": 7.94,
- "ranking": 13.277249451353326
}, - "current": 30.8
}, - "stdv": {
- "one_y": 0.022194779717709473,
- "five_d": 0.012010710239603354
}, - "trend": {
- "middle_term": -1,
- "short_term": 0
}, - "positive_scenario_probability": 55,
- "semi_return": 1.08,
- "beta_ibov": 1.071423011965741,
- "correl_ibov": 0.6491098756697858
}, - "staged": false
}, - "market": {
- "open": 0.97,
- "high": 1.12,
- "low": 0.9,
- "close": 0.93,
- "vol": 450200,
- "fin_volume": 462025,
- "trades": 0,
- "bid": 0.8,
- "ask": 0.98,
- "variation": -7.921,
- "previous_close": 1
}, - "info": {
- "maturity_type": "AMERICAN",
- "days_to_maturity": 16,
- "due_date": "2021-07-16",
- "strike": 16.37,
- "category": "CALL",
- "contract_size": 100,
- "spot_price": 17.01
}, - "quant": null,
- "staged": false
}Obtém uma lista com as ordens do portfólio especificado
| portfolio_id required | integer ID do portfólio |
| from | string <date-time> Data de início da consulta |
| to | string <date-time> Data de fim da consulta |
| page | integer Número da página da pesquisa |
| per | integer Quantidade de itens por página |
| ticker | string Example: ticker=PETR Código do ativo das ordens a serem listadas, pode ser informado um valor parcial |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem das ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status das ordens a serem listadas. Aceita mais de um valor, separando por vírgula. Obs: Quando o valor |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| side | string Enum: "SELL" "BUY" Lado das ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| show_position | boolean Default: true Determina se as ordens devem incluir as informações da posição |
| Total-Pages | integer Example: 147 Número total de páginas considerando o parâmetro |
| Page-Size | integer Example: 200 Tamanho das páginas |
| Current-Page | integer Example: 5 Número da página atual |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
object Posição a qual a ordem pertence | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders?from={from}&to={to}&page={page}&per={per}&ticker={ticker}&origin={origin}&status={status}&order_type={order_type}&side={side}&show_position={show_position}' \ -H 'Access-Token: {access-token}'
[- {
- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "type": "stock",
- "due_date": null,
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "underlying_asset": null
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}
]Inclui uma ordem no portfólio especificado
| portfolio_id required | integer ID do portfólio |
| symbol required | string Código de negociação do instrumento |
| price required | number Preço unitário do papel. Obrigatório, com exceção de quando o order_type é |
| amount required | number Quantidade de papéis |
| side required | string Enum: "SELL" "BUY" Tipo de ordem |
| order_type | string Default: "manual" Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem. Para ordens não roteadas, o tipo deve ser |
| origin | string Default: "simulator" Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| time_in_force | string Default: "day" Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| brokerage | number Taxa da corretora |
| status | string Default: "pending" Enum: "pending" "filled" "staged" Status da ordem. Só é considerado em ordens do tipo |
| trading_account_id | integer ID da conta de trade. Define se a ordem será roteada |
| created_at | string <date-time> Data que a ordem foi criada |
| expires_at | string <date-time> Data de expiração da ordem. Obrigatório quando o order_type é |
| trigger_price | number Preço de gatilho para ordens |
| executed_at | string <date-time> Data que a ordem foi executada. Só é considerada em ordens do tipo |
| tags | Array of strings Tags associadas a ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
[- {
- "symbol": "PETR3",
- "price": 28,
- "amount": 1000,
- "side": "BUY",
- "order_type": "market",
- "origin": "order_ticket",
- "time_in_force": "day",
- "brokerage": 0,
- "status": "pending",
- "trading_account_id": 9,
- "created_at": "2021-06-19T02:59:59.999Z",
- "expires_at": "2021-06-24T02:59:59.999Z",
- "trigger_price": 28.1,
- "executed_at": null,
- "tags": [
- "exemplo"
]
}
]{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Obtém um objeto com os dados da ordem especificada
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Altera os dados da ordem especificada do portfólio
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da ordem |
| price | number Preço unitário do papel |
| amount | number Quantidade de papéis |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| trigger_price | number Preço de gatilho para ordens |
| expires_at | string <date-time> Data de expiração da ordem |
| executed_at | string <date-time> Data que a ordem foi executada. Só pode ser alterada em ordens do tipo |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
{- "price": 28,
- "amount": 1000,
- "side": "BUY",
- "time_in_force": "day",
- "trigger_price": 28.1,
- "expires_at": "2021-06-24T02:59:59.999Z",
- "executed_at": null
}{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Cancela a ordem especificada do portfólio
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Executa a ordem especificada do portfólio, a ordem deve ser do tipo manual e estar com status pending
| portfolio_id required | integer ID do portfólio |
| id required | integer ID da ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X POST \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders/{id}/execute' \ -H 'Access-Token: {access-token}'
{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Obtém a quantidade de ordens pendentes do portfólio especificado
| portfolio_id required | integer ID do portfólio |
| count | integer Quantidade de ordens pendentes |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders/pending' \ -H 'Access-Token: {access-token}'
{- "count": 10
}Executa um processo em segundo plano que gera um arquivo em formato CSV com todas as ordens contidas no portfólio especificado. Ao término do processamento, envia uma notificação via sistema com o link para download do arquivo
| portfolio_id required | integer ID do portfólio |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/orders/{id}/export' \ -H 'Access-Token: {access-token}'
Obtém uma lista com as ordens da posição especificada
| portfolio_id required | integer ID do portfólio |
| position_id required | integer ID da posição |
| from | string <date-time> Data de início da consulta |
| to | string <date-time> Data de fim da consulta |
| page | integer Número da página da pesquisa |
| per | integer Quantidade de itens por página |
| ticker | string Example: ticker=PETR Código do ativo das ordens a serem listadas, pode ser informado um valor parcial |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem das ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status das ordens a serem listadas. Aceita mais de um valor, separando por vírgula. Obs: Quando o valor |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| side | string Enum: "SELL" "BUY" Lado das ordens a serem listadas. Aceita mais de um valor, separando por vírgula |
| show_position | boolean Default: true Determina se as ordens devem incluir as informações da posição |
| Total-Pages | integer Example: 147 Número total de páginas considerando o parâmetro |
| Page-Size | integer Example: 200 Tamanho das páginas |
| Current-Page | integer Example: 5 Número da página atual |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
object Posição a qual a ordem pertence | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{position_id}/orders?from={from}&to={to}&page={page}&per={per}&ticker={ticker}&origin={origin}&status={status}&order_type={order_type}&side={side}&show_position={show_position}' \ -H 'Access-Token: {access-token}'
[- {
- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "type": "stock",
- "due_date": null,
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "underlying_asset": null
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}
]Inclui uma ordem na posição especificada
| portfolio_id required | integer ID do portfólio |
| position_id required | integer ID da posição |
| symbol required | string Código de negociação do instrumento |
| price required | number Preço unitário do papel. Obrigatório, com exceção de quando o order_type é |
| amount required | number Quantidade de papéis |
| side required | string Enum: "SELL" "BUY" Tipo de ordem |
| order_type | string Default: "manual" Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem. Para ordens não roteadas, o tipo deve ser |
| origin | string Default: "simulator" Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| time_in_force | string Default: "day" Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| brokerage | number Taxa da corretora |
| status | string Default: "pending" Enum: "pending" "filled" "staged" Status da ordem. Só é considerado em ordens do tipo |
| trading_account_id | integer ID da conta de trade. Define se a ordem será roteada |
| created_at | string <date-time> Data que a ordem foi criada |
| expires_at | string <date-time> Data de expiração da ordem. Obrigatório quando o order_type é |
| trigger_price | number Preço de gatilho para ordens |
| executed_at | string <date-time> Data que a ordem foi executada. Só é considerada em ordens do tipo |
| tags | Array of strings Tags associadas a ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
[- {
- "symbol": "PETR3",
- "price": 28,
- "amount": 1000,
- "side": "BUY",
- "order_type": "market",
- "origin": "order_ticket",
- "time_in_force": "day",
- "brokerage": 0,
- "status": "pending",
- "trading_account_id": 9,
- "created_at": "2021-06-19T02:59:59.999Z",
- "expires_at": "2021-06-24T02:59:59.999Z",
- "trigger_price": 28.1,
- "executed_at": null,
- "tags": [
- "exemplo"
]
}
]{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Obtém um objeto com os dados da ordem especificada da posição
| portfolio_id required | integer ID do portfólio |
| position_id required | integer ID da posição |
| id required | integer ID da ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{position_id}/orders/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Altera os dados da ordem especificada da posição
| portfolio_id required | integer ID do portfólio |
| position_id required | integer ID da posição |
| id required | integer ID da ordem |
| price | number Preço unitário do papel |
| amount | number Quantidade de papéis |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| trigger_price | number Preço de gatilho para ordens |
| expires_at | string <date-time> Data de expiração da ordem |
| executed_at | string <date-time> Data que a ordem foi executada. Só pode ser alterada em ordens do tipo |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
{- "price": 28,
- "amount": 1000,
- "side": "BUY",
- "time_in_force": "day",
- "trigger_price": 28.1,
- "expires_at": "2021-06-24T02:59:59.999Z",
- "executed_at": null
}{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Cancela a ordem especificada da posição
| portfolio_id required | integer ID do portfólio |
| position_id required | integer ID da posição |
| id required | integer ID da ordem |
| id | integer ID da ordem |
| order_type | string Enum: "manual" "market" "limit" "stop_limit" Tipo de ordem |
| action | integer Enum: 1 -1 enumDescriptions: {"1":"Venda","-1":"Compra"} Tipo de ordem |
| amount | number Quantidade da ordem que foi executada |
| price | number Preço pelo qual a ordem foi executada |
| status | string Enum: "pending" "filled" "canceled" "staged" "created" … 12 more Status atual da ordem |
| created_at | string <date-time> Data que a ordem foi criada |
| updated_at | string <date-time> Data que a ordem foi atualizada |
| brokerage | number or null Taxa da corretora |
| symbol | string Código de negociação do instrumento |
| expires_at | string or null <date-time> Data de expiração de ordens |
| executed_at | string or null <date-time> Data que a ordem foi executada |
| trigger_price | number or null Preço de gatilho para ordens |
| target_price | number or null Preço de compra/venda objetivo da ordem |
| target_amount | integer or null Quantidade objetivo da ordem |
| origin | string Enum: "simulator" "order_ticket" "robot" Origem da ordem |
| broker_message | string or null Mensagem da corretora |
| time_in_force | string Enum: "day" "good_till_cancel" "at_the_opening" "immediate_or_cancel" "fill_or_kill" … 3 more Tipo de validade da ordem |
| tags | string or null Tags associadas a ordem separadas por vírgula |
| side | string Enum: "SELL" "BUY" Tipo de ordem |
OptionPosition (object) or StockOrBondPosition (object) | |
object or null Conta de trade em que a ordem foi enviada |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/portfolios/{portfolio_id}/positions/{position_id}/orders/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 11364,
- "order_type": "market",
- "action": -1,
- "amount": 1000,
- "price": 28,
- "status": "filled",
- "created_at": "2021-06-18T23:59:59.999-03:00",
- "updated_at": "2021-06-29T20:31:39.967-03:00",
- "brokerage": 0,
- "symbol": "PETR3",
- "expires_at": "2021-06-23T23:59:59.999-03:00",
- "executed_at": "2021-06-22T15:54:41.654-03:00",
- "trigger_price": 28.1,
- "target_price": 28,
- "target_amount": 1000,
- "origin": "order_ticket",
- "broker_message": null,
- "time_in_force": "day",
- "tags": null,
- "side": "BUY",
- "position": {
- "id": 41977,
- "portfolio_id": 16519,
- "amount": 1000,
- "average_price": 28,
- "weight": -107.223000865443,
- "tags": [
- "$stock",
- "$shares"
], - "strategy": null,
- "balance": {
- "initial": -28000,
- "realized": 0,
- "current": -28000
}, - "exchange": "BOVESPA",
- "type": "stock",
- "name": "PETROBRAS ON",
- "symbol": "PETR3",
- "robots": null,
- "market": {
- "open": 29.32,
- "high": 29.76,
- "low": 29,
- "close": 29.64,
- "vol": 18376200,
- "fin_volume": 542417000,
- "trades": 0,
- "bid": 29.63,
- "ask": 29.69,
- "variation": 1.23,
- "previous_close": 29.27
}, - "info": {
- "category": "VISTA",
- "contract_size": 100,
- "has_options": true
}, - "quant": {
- "ewma": {
- "one_y": {
- "max": 84,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "six_m": {
- "max": 66.4,
- "min": 44.4,
- "percentile": 0,
- "ranking": 0
}, - "current": 44.4
}, - "iv": {
- "one_y": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 14.29,
- "ranking": 14.38356164383562
}, - "six_m": {
- "max": 80.03,
- "min": 27.47,
- "percentile": 18.25,
- "ranking": 14.38356164383562
}, - "current": 35.03
}, - "stdv": {
- "one_y": 0.028403822331634,
- "five_d": 0.011658168721413198
}, - "trend": {
- "middle_term": 1,
- "short_term": 1
}, - "positive_scenario_probability": 50,
- "semi_return": 1.05,
- "beta_ibov": 1.5717246369977986,
- "correl_ibov": 0.742794963517836
}, - "staged": false
}, - "trading_account": {
- "id": 9,
- "status": "active",
- "broker": {
- "id": 1,
- "name": "Exemplo"
}
}
}Obtém uma lista com todas as watchlists do usuário
| id | integer ID da watchlist |
| name | string or null Nome da watchlist |
| is_default | boolean Indica se é a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
Array of objects Lista de instrumentos da watchlist |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/watchlists' \ -H 'Access-Token: {access-token}'
[- {
- "id": 25501,
- "name": "Minha watchlist",
- "is_default": true,
- "sort": 1,
- "instruments": [
- {
- "symbol": "ABEV3",
- "price": 17.61,
- "variation": 0.399,
- "weight": 20,
- "amount": 100,
- "average-price": 14.68
}, - {
- "symbol": "PETR4",
- "price": 25.95,
- "variation": 0.077,
- "weight": 10
}
]
}
]Inclui uma nova watchlist para o usuário
| name | string Nome da watchlist |
| is_default | boolean Determina se esta será a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
| id | integer ID da watchlist |
| name | string or null Nome da watchlist |
| is_default | boolean Indica se é a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
Array of objects Lista de instrumentos da watchlist |
{- "name": "Minha super watchlist",
- "is_default": false,
- "sort": 1
}{- "id": 25887,
- "name": "Minha super watchlist",
- "is_default": false,
- "sort": 1,
- "instruments": [ ]
}Obtém os dados da watchlist especificada
| id required | integer ID da watchlist. Enviando a palavra |
| id | integer ID da watchlist |
| name | string or null Nome da watchlist |
| is_default | boolean Indica se é a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
Array of objects Lista de instrumentos da watchlist |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/watchlists/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 25887,
- "name": "Minha watchlist favorita",
- "is_default": true,
- "sort": 1,
- "instruments": [
- {
- "symbol": "ABEV3",
- "price": 17.7,
- "variation": 0.511,
- "weight": 0,
- "amount": 100,
- "average-price": 14.68
}
]
}Altera os dados da watchlist determinada
| id required | integer ID da watchlist. Enviando a palavra |
| name | string Nome da watchlist |
| is_default | boolean Determina se esta será a watchlist padrão |
| sort | integer Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
| id | integer ID da watchlist |
| name | string or null Nome da watchlist |
| is_default | boolean Indica se é a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
Array of objects Lista de instrumentos da watchlist |
{- "name": "Minha watchlist favorita",
- "is_default": true,
- "sort": 1
}{- "id": 25887,
- "name": "Minha watchlist favorita",
- "is_default": true,
- "sort": 1,
- "instruments": [
- {
- "symbol": "ABEV3",
- "price": 17.7,
- "variation": 0.511,
- "weight": 0,
- "amount": 100,
- "average-price": 14.68
}
]
}Remove uma determinada watchlist
| id required | integer ID da watchlist. Enviando a palavra |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/watchlists/{id}' \ -H 'Access-Token: {access-token}'
{- "error": "string"
}Inclui um determinado instrumento na watchlist determinada
| id required | integer ID da watchlist. Enviando a palavra |
| symbol required | string Código de negociação do instrumento |
| weight | integer Default: 0 Priorização do instrumento na lista (ordem crescente) |
| id | integer ID da watchlist |
| name | string or null Nome da watchlist |
| is_default | boolean Indica se é a watchlist padrão |
| sort | integer Default: 1 Enum: 1 -1 2 -2 3 … 1 more enumDescriptions: {"1":"Código dos instrumentos crescente","2":"Preço atual crescente","3":"Variação do dia crescente","-1":"Código dos instrumentos decrescente","-2":"Preço atual decrescente","-3":"Variação do dia decrescente"} Indica o tipo de ordenação dos instrumentos da watchlist no front |
Array of objects Lista de instrumentos da watchlist |
{- "weight": 10
}{- "id": 25887,
- "name": "Minha watchlist favorita",
- "is_default": true,
- "sort": 1,
- "instruments": [
- {
- "symbol": "ABEV3",
- "price": 17.7,
- "variation": 0.511,
- "weight": 0,
- "amount": 100,
- "average-price": 14.68
}
]
}Remove um determinado instrumento da watchlist determinada
| id required | integer ID da watchlist. Enviando a palavra |
| symbol required | string Código de negociação do instrumento |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/watchlists/{id}/{symbol}' \ -H 'Access-Token: {access-token}'
Obtém uma lista com todas as notificações recebidas do usuário
| page | integer Número da página da pesquisa |
| per | integer Quantidade de itens por página |
| id | integer ID da notificação |
| read_at | string or null <date-time> Data que o usuário leu a notificação |
| ack_at | string or null <date-time> Data que o usuário aceitou a notificação |
| sent_at | string <date-time> Data que a notificação foi enviada |
| deleted_at | string or null <date-time> Data que o usuário apagou a notificação |
object (MessageInfo) | |
| created_at | string <date-time> Data que a notificação foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/notifications?page={page}&per={per}' \ -H 'Access-Token: {access-token}'
[- {
- "id": 4,
- "read_at": null,
- "ack_at": null,
- "sent_at": "2021-07-19T17:59:45.667-03:00",
- "deleted_at": null,
- "message": {
- "id": 1,
- "channel": "System",
- "title": "Mensagem teste",
- "body": "Corpo de teste",
- "priority": "low",
- "status": "approved",
- "reason": null,
- "author_id": 1,
- "confirmable": false,
- "delivered_at": null,
- "scheduled_to": null,
- "created_at": "2021-07-16T15:39:27.566-03:00",
- "updated_at": "2021-07-16T17:00:07.395-03:00"
}, - "created_at": "2021-07-18T17:40:00.154-03:00",
- "updated_at": "2021-07-18T17:40:00.154-03:00"
}, - {
- "id": 5,
- "read_at": null,
- "ack_at": null,
- "sent_at": "2021-07-19T18:48:12.456-03:00",
- "deleted_at": null,
- "message": {
- "id": 2,
- "channel": "System",
- "title": "Título exemplo",
- "body": "Corpo de exemplo",
- "priority": "low",
- "status": "created",
- "reason": null,
- "author_id": 1,
- "confirmable": false,
- "delivered_at": null,
- "scheduled_to": "2021-07-19T10:00:00.000-03:00",
- "created_at": "2021-07-16T17:00:59.274-03:00",
- "updated_at": "2021-07-16T17:00:59.274-03:00"
}, - "created_at": "2021-07-18T17:40:00.154-03:00",
- "updated_at": "2021-07-18T17:40:00.154-03:00"
}
]Obtém um objeto com os dados da notificação especificada
| id required | integer ID da notificação |
| id | integer ID da notificação |
| read_at | string or null <date-time> Data que o usuário leu a notificação |
| ack_at | string or null <date-time> Data que o usuário aceitou a notificação |
| sent_at | string <date-time> Data que a notificação foi enviada |
| deleted_at | string or null <date-time> Data que o usuário apagou a notificação |
object (MessageInfo) | |
| created_at | string <date-time> Data que a notificação foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/notifications/{id}' \ -H 'Access-Token: {access-token}'
{- "id": 5,
- "read_at": null,
- "ack_at": null,
- "sent_at": "2021-07-19T10:15:25.248-03:00",
- "deleted_at": null,
- "message": {
- "id": 2,
- "channel": "System",
- "title": "Título exemplo",
- "body": "Corpo de exemplo",
- "priority": "low",
- "status": "created",
- "reason": "Exemplo",
- "author_id": 1,
- "confirmable": false,
- "delivered_at": null,
- "scheduled_to": "2021-07-19T10:00:00.000-03:00",
- "created_at": "2021-07-16T17:00:59.274-03:00",
- "updated_at": "2021-07-16T17:00:59.274-03:00"
}, - "created_at": "2021-07-18T17:40:00.154-03:00",
- "updated_at": "2021-07-18T17:40:00.154-03:00"
}Altera os dados da notificação especificada
| id required | integer ID da notificação |
| ack_at | string <date-time> Data que o usuário aceitou a notificação |
| read_at | string <date-time> Data que o usuário leu a notificação |
| deleted_at | string <date-time> Data que o usuário apagou a notificação |
| id | integer ID da notificação |
| read_at | string or null <date-time> Data que o usuário leu a notificação |
| ack_at | string or null <date-time> Data que o usuário aceitou a notificação |
| sent_at | string <date-time> Data que a notificação foi enviada |
| deleted_at | string or null <date-time> Data que o usuário apagou a notificação |
object (MessageInfo) | |
| created_at | string <date-time> Data que a notificação foi criada |
| updated_at | string <date-time> Data da última atualização dos dados |
{- "ack_at": "2021-07-19T17:59:45.667-03:00",
- "read_at": "2021-07-19T17:59:45.667-03:00",
- "deleted_at": null
}{- "id": 5,
- "read_at": null,
- "ack_at": null,
- "sent_at": "2021-07-19T10:15:25.248-03:00",
- "deleted_at": null,
- "message": {
- "id": 2,
- "channel": "System",
- "title": "Título exemplo",
- "body": "Corpo de exemplo",
- "priority": "low",
- "status": "created",
- "reason": "Exemplo",
- "author_id": 1,
- "confirmable": false,
- "delivered_at": null,
- "scheduled_to": "2021-07-19T10:00:00.000-03:00",
- "created_at": "2021-07-16T17:00:59.274-03:00",
- "updated_at": "2021-07-16T17:00:59.274-03:00"
}, - "created_at": "2021-07-18T17:40:00.154-03:00",
- "updated_at": "2021-07-18T17:40:00.154-03:00"
}Remove os dados da notificação especificada
| id required | integer ID da notificação |
curl -i -X DELETE \ 'https://api.oplab.com.br/v3/domain/notifications/{id}' \ -H 'Access-Token: {access-token}'
{- "error": "string"
}Obtém a quantidade de notificações não lidas do usuário
| count | integer Quantidade de notificações não lidas |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/notifications/unread' \ -H 'Access-Token: {access-token}'
{- "count": 5
}Obtém uma lista com todas as preferências de notificações do usuário
| id | integer ID do objeto |
| user_id | integer ID do usuário |
object Canal de mensagens referido | |
| destination_mask | integer Máscara de preferência cadastrada |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/notifications/preferences' \ -H 'Access-Token: {access-token}'
[- {
- "id": 3,
- "user_id": 10518,
- "channel": {
- "id": 1,
- "name": "System",
- "default_destination_mask": 1,
- "minimum_destination_mask": 0,
- "created_at": "2021-07-20T14:24:41.423-03:00",
- "updated_at": "2021-07-20T14:24:41.423-03:00"
}, - "destination_mask": 111,
- "created_at": "2021-07-18T17:40:00.154-03:00",
- "updated_at": "2021-07-18T17:40:00.154-03:00"
}, - {
- "id": 4,
- "user_id": 10518,
- "channel": {
- "id": 2,
- "name": "Billing",
- "default_destination_mask": 1,
- "minimum_destination_mask": 0,
- "created_at": "2021-07-20T14:24:41.426-03:00",
- "updated_at": "2021-07-20T14:24:41.426-03:00"
}, - "destination_mask": 111,
- "created_at": "2021-07-18T17:40:00.164-03:00",
- "updated_at": "2021-07-18T17:40:00.164-03:00"
}, - {
- "id": 5,
- "user_id": 10518,
- "channel": {
- "id": 3,
- "name": "Trading",
- "default_destination_mask": 1,
- "minimum_destination_mask": 0,
- "created_at": "2021-07-20T14:24:41.429-03:00",
- "updated_at": "2021-07-20T14:24:41.429-03:00"
}, - "destination_mask": 111,
- "created_at": "2021-07-18T17:40:00.174-03:00",
- "updated_at": "2021-07-18T17:40:00.174-03:00"
}, - {
- "id": 6,
- "user_id": 10518,
- "channel": {
- "id": 4,
- "name": "Marketing",
- "default_destination_mask": 1,
- "minimum_destination_mask": 0,
- "created_at": "2021-07-20T14:24:41.431-03:00",
- "updated_at": "2021-07-20T14:24:41.431-03:00"
}, - "destination_mask": 111,
- "created_at": "2021-07-18T17:40:00.184-03:00",
- "updated_at": "2021-07-18T17:40:00.184-03:00"
}
]Altera as preferências de notificações do usuário
Array of objects Preferências de notificações | |||||
Array
| |||||
{- "preferences": [
- {
- "channel_id": 1,
- "destination_mask": 10
}
]
}{- "error": "string"
}Obtém um objeto com a quantidade de dias úteis até a data especificada
| until required | string <date> Example: 2022-05-16 Data de referência |
| business_days | integer Quantidade de dias úteis até a data de referência |
curl -i -X GET \ 'https://api.oplab.com.br/v3/domain/trading/business_days/{until}' \ -H 'Access-Token: {access-token}'
{- "business_days": 26
}Obtém uma lista com todas as taxas de juros disponíveis
| uid | string Enum: "CETIP" "SELIC" Sigla da taxa de juros |
| name | string Nome da taxa de juros |
| value | number Valor da taxa de juros (%) |
| updated_at | string <date-time> Data e hora da última atualização dos dados |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/interest_rates' \ -H 'Access-Token: {access-token}'
[- {
- "uid": "CETIP",
- "name": "Taxa DI",
- "value": 3.4,
- "updated_at": "2021-05-06T22:12:47.359Z"
}, - {
- "uid": "SELIC",
- "name": "Taxa Selic",
- "value": 3.4000915787165464,
- "updated_at": "2021-05-06T22:12:47.741Z"
}
]Obtém os dados da taxa de juros especificada
| id required | string Sigla da taxa de juros |
| uid | string Enum: "CETIP" "SELIC" Sigla da taxa de juros |
| name | string Nome da taxa de juros |
| value | number Valor da taxa de juros (%) |
| updated_at | string <date-time> Data e hora da última atualização dos dados |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/interest_rates/{id}' \ -H 'Access-Token: {access-token}'
{- "uid": "CETIP",
- "name": "Taxa DI",
- "value": 3.4,
- "updated_at": "2021-05-06T22:12:47.359Z"
}Obtém uma lista com as informações das bolsas de valores no Brasil
| uid | string UID do registro |
| name | string Nome da bolsa de valores |
| opensAt | string <date> Abertura do mercado |
| closesAt | string <date> Fechamento do mercado |
| afterHoursStartsAt | string Horário de inicio do after market |
| afterHoursEndsAt | string Horário de fim do after market |
| createdAt | string <date> Registro criado em |
| updatedAt | string <date> Registro atualizado em |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/exchanges' \ -H 'Access-Token: {access-token}'
[- {
- "uid": "BCB",
- "name": "Banco Central do Brasil",
- "opensAt": "09:00:00",
- "closesAt": "18:00:00",
- "afterHoursStartsAt": "18:01:00",
- "afterHoursEndsAt": "18:05:00",
- "createdAt": "2020-02-21T21:52:27.833Z",
- "updatedAt": "2020-02-21T21:52:27.833Z"
}
]Obtém os dados da bolsa de valores especificada
| uid required | string UID da bolsa |
| uid | string UID do registro |
| name | string Nome da bolsa de valores |
| opensAt | string <date> Abertura do mercado |
| closesAt | string <date> Fechamento do mercado |
| afterHoursStartsAt | string Horário de inicio do after market |
| afterHoursEndsAt | string Horário de fim do after market |
| createdAt | string <date> Registro criado em |
| updatedAt | string <date> Registro atualizado em |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/exchanges/{uid}' \ -H 'Access-Token: {access-token}'
{- "uid": "BCB",
- "name": "Banco Central do Brasil",
- "opensAt": "09:00:00",
- "closesAt": "18:00:00",
- "afterHoursStartsAt": "18:01:00",
- "afterHoursEndsAt": "18:05:00",
- "createdAt": "2020-02-21T21:52:27.833Z",
- "updatedAt": "2020-02-21T21:52:27.833Z"
}Obtém uma lista com todas as ações que possuem opções listadas
| rank_by | string Default: "volume" Enum: "symbol" "type" "name" "open" "high" … 47 more Atributo para ordenação da lista. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| symbol | string Código de negociação do ativo alvo |
| type | string Tipo do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Value: "VISTA" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ewma_1y_max | number or null Volatilidade EWMA histórica máxima no período de 1 ano |
| ewma_1y_min | number or null Volatilidade EWMA histórica mínima no período de 1 ano |
| ewma_1y_percentile | number or null Percentil da volatilidade EWMA histórica em 1 ano |
| ewma_1y_rank | number or null Classificação da volatilidade EWMA histórica em 1 ano |
| ewma_6m_max | number or null Volatilidade EWMA histórica máxima no período de 6 meses |
| ewma_6m_min | number or null Volatilidade EWMA histórica mínima no período de 6 meses |
| ewma_6m_percentile | number or null Percentil da volatilidade EWMA histórica em 6 meses |
| ewma_6m_rank | number or null Classificação da volatilidade EWMA histórica em 6 meses |
| ewma_current | number Volatilidade EWMA atual |
| has_options | boolean Indica se esta ação tem opções listadas na B3 |
| iv_1y_max | number or null Volatilidade implícita máxima no período de 1 ano |
| iv_1y_min | number or null Volatilidade implícita mínima no período de 1 ano |
| iv_1y_percentile | number or null Percentil da volatilidade implícita em 1 ano |
| iv_1y_rank | number or null Classificação da volatilidade implícita em 1 ano |
| iv_6m_max | number or null Volatilidade implícita máxima no período de 6 meses |
| iv_6m_min | number or null Volatilidade implícita mínima no período de 6 meses |
| iv_6m_percentile | number or null Percentil da volatilidade implícita em 6 meses |
| iv_6m_rank | number or null Classificação da volatilidade implícita em 6 meses |
| iv_current | number Volatilidade implícita atual |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| semi_return_1y | number or null Semi-retorno no período de 1 ano |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
| due_date | string or null <date> Data de vencimento do instrumento |
| maturity_type | string or null Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| parent_symbol | string or null Código de negociação do ativo alvo |
| spot_price | number or null Preço atual do ativo alvo |
| strike | number or null Valor de exercício da opção |
| garch11_1y | number or null Volatilidade conforme modelo GARCH no período de 1 ano |
| isin | string Código ISIN do ativo |
| cnpj | string CNPJ da companhia |
| correl_ibov | number Valor da correlação com o índice IBOV |
object Média móvel de 9 e 21 de dias | |
| entropy | number Medida de incerteza do ativo |
object Score do OpLab baseado em indicadores fundamentalistas | |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| polynomials_2 | object Metodologia do OpLab para calcular o preço de um ativo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| sector | string Setor da companhia |
| quotation_form | integer Tipo de cotação |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| highest_options_volume_rank | integer Classificação do maior volume de opções do dia anterior |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
object Diferença da tendência de curto e médio prazo | |
| last_trade_at | integer or null Timestamp do último negócio |
| long_name | string Nome da companhia |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| previous_close | number Fechamento do dia anterior |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/stocks?rank_by={rank_by}&sort={sort}&limit={limit}&financial_volume_start={financial_volume_start}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETR4",
- "type": "STOCK",
- "name": "PETROBRAS PN",
- "open": 24.8,
- "high": 24.98,
- "low": 24.58,
- "close": 24.71,
- "volume": 73804500,
- "financial_volume": 1829930000,
- "trades": 0,
- "bid": 24.7,
- "ask": 24.71,
- "category": "VISTA",
- "contract_size": 100,
- "created_at": "2021-05-07T22:03:00.010Z",
- "updated_at": "2021-05-07T22:03:00.010Z",
- "variation": 1.354,
- "ewma_1y_max": 89.61,
- "ewma_1y_min": 49.98,
- "ewma_1y_percentile": 7.94,
- "ewma_1y_rank": 6,
- "ewma_6m_max": 67.19,
- "ewma_6m_min": 49.98,
- "ewma_6m_percentile": 15.87,
- "ewma_6m_rank": 13.82,
- "ewma_current": 52.36,
- "has_options": true,
- "iv_1y_max": 70.89,
- "iv_1y_min": 33.4,
- "iv_1y_percentile": 53.17,
- "iv_1y_rank": 22.38,
- "iv_6m_max": 70.89,
- "iv_6m_min": 35.16,
- "iv_6m_percentile": 53.17,
- "iv_6m_rank": 18.56,
- "iv_current": 41.79,
- "middle_term_trend": 0,
- "semi_return_1y": 1.12,
- "short_term_trend": 0,
- "stdv_1y": 0.030376505142433452,
- "stdv_5d": 0.02673558724536745,
- "beta_ibov": 1.5421326782884273,
- "due_date": null,
- "maturity_type": null,
- "parent_symbol": null,
- "spot_price": null,
- "strike": null,
- "garch11_1y": 50.59,
- "isin": "BRPETRACNPR6",
- "cnpj": "33000167000101",
- "correl_ibov": 0.7470931521875993,
- "m9_m21": {
- "value": 1.0042260646940864,
- "trend": 1
}, - "entropy": 0.591727002114042,
- "oplab_score": {
- "ebit_var": 0,
- "revenue_var": 0,
- "cash_var": 1,
- "current_liabilities": 0,
- "mm_signal": 2,
- "date": "2020-12-31",
- "value": 3
}, - "security_category": 11,
- "polynomials_2": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "polynomials_3": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "sector": "PETRÓLEO E GÁS",
- "quotation_form": 100,
- "market_maker": false,
- "highest_options_volume_rank": 2,
- "days_to_maturity": 0,
- "mshort_mlong": {
- "value": 1.0614983633420205,
- "trend": 1
}, - "last_trade_at": 0,
- "long_name": "PETROLEO BRASILEIRO S.A. PETROBRAS",
- "bid_volume": 700,
- "ask_volume": 1400,
- "time": 1620680400000,
- "previous_close": 23.84
}
]Obtém uma lista com todas as ações negociadas na B3
| page | integer Default: 1 Número da página |
| per | integer Default: 20 Quantidade de itens por página |
| rank_by | string Default: "symbol" Enum: "symbol" "type" "name" "open" "high" … 47 more Atributo para ordenação da lista. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| total-pages | integer Example: 147 Número total de páginas considerando o parâmetro |
| symbol | string Código de negociação do ativo alvo |
| type | string Tipo do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Value: "VISTA" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ewma_1y_max | number or null Volatilidade EWMA histórica máxima no período de 1 ano |
| ewma_1y_min | number or null Volatilidade EWMA histórica mínima no período de 1 ano |
| ewma_1y_percentile | number or null Percentil da volatilidade EWMA histórica em 1 ano |
| ewma_1y_rank | number or null Classificação da volatilidade EWMA histórica em 1 ano |
| ewma_6m_max | number or null Volatilidade EWMA histórica máxima no período de 6 meses |
| ewma_6m_min | number or null Volatilidade EWMA histórica mínima no período de 6 meses |
| ewma_6m_percentile | number or null Percentil da volatilidade EWMA histórica em 6 meses |
| ewma_6m_rank | number or null Classificação da volatilidade EWMA histórica em 6 meses |
| ewma_current | number Volatilidade EWMA atual |
| has_options | boolean Indica se esta ação tem opções listadas na B3 |
| iv_1y_max | number or null Volatilidade implícita máxima no período de 1 ano |
| iv_1y_min | number or null Volatilidade implícita mínima no período de 1 ano |
| iv_1y_percentile | number or null Percentil da volatilidade implícita em 1 ano |
| iv_1y_rank | number or null Classificação da volatilidade implícita em 1 ano |
| iv_6m_max | number or null Volatilidade implícita máxima no período de 6 meses |
| iv_6m_min | number or null Volatilidade implícita mínima no período de 6 meses |
| iv_6m_percentile | number or null Percentil da volatilidade implícita em 6 meses |
| iv_6m_rank | number or null Classificação da volatilidade implícita em 6 meses |
| iv_current | number Volatilidade implícita atual |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| semi_return_1y | number or null Semi-retorno no período de 1 ano |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
| due_date | string or null <date> Data de vencimento do instrumento |
| maturity_type | string or null Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| parent_symbol | string or null Código de negociação do ativo alvo |
| spot_price | number or null Preço atual do ativo alvo |
| strike | number or null Valor de exercício da opção |
| garch11_1y | number or null Volatilidade conforme modelo GARCH no período de 1 ano |
| isin | string Código ISIN do ativo |
| cnpj | string CNPJ da companhia |
| correl_ibov | number Valor da correlação com o índice IBOV |
object Média móvel de 9 e 21 de dias | |
| entropy | number Medida de incerteza do ativo |
object Score do OpLab baseado em indicadores fundamentalistas | |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| polynomials_2 | object Metodologia do OpLab para calcular o preço de um ativo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| sector | string Setor da companhia |
| quotation_form | integer Tipo de cotação |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| highest_options_volume_rank | integer Classificação do maior volume de opções do dia anterior |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
object Diferença da tendência de curto e médio prazo | |
| last_trade_at | integer or null Timestamp do último negócio |
| long_name | string Nome da companhia |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| previous_close | number Fechamento do dia anterior |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/stocks/all?page={page}&per={per}&rank_by={rank_by}&sort={sort}&financial_volume_start={financial_volume_start}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETR4",
- "type": "STOCK",
- "name": "PETROBRAS PN",
- "open": 24.8,
- "high": 24.98,
- "low": 24.58,
- "close": 24.71,
- "volume": 73804500,
- "financial_volume": 1829930000,
- "trades": 0,
- "bid": 24.7,
- "ask": 24.71,
- "category": "VISTA",
- "contract_size": 100,
- "created_at": "2021-05-07T22:03:00.010Z",
- "updated_at": "2021-05-07T22:03:00.010Z",
- "variation": 1.354,
- "ewma_1y_max": 89.61,
- "ewma_1y_min": 49.98,
- "ewma_1y_percentile": 7.94,
- "ewma_1y_rank": 6,
- "ewma_6m_max": 67.19,
- "ewma_6m_min": 49.98,
- "ewma_6m_percentile": 15.87,
- "ewma_6m_rank": 13.82,
- "ewma_current": 52.36,
- "has_options": true,
- "iv_1y_max": 70.89,
- "iv_1y_min": 33.4,
- "iv_1y_percentile": 53.17,
- "iv_1y_rank": 22.38,
- "iv_6m_max": 70.89,
- "iv_6m_min": 35.16,
- "iv_6m_percentile": 53.17,
- "iv_6m_rank": 18.56,
- "iv_current": 41.79,
- "middle_term_trend": 0,
- "semi_return_1y": 1.12,
- "short_term_trend": 0,
- "stdv_1y": 0.030376505142433452,
- "stdv_5d": 0.02673558724536745,
- "beta_ibov": 1.5421326782884273,
- "due_date": null,
- "maturity_type": null,
- "parent_symbol": null,
- "spot_price": null,
- "strike": null,
- "garch11_1y": 50.59,
- "isin": "BRPETRACNPR6",
- "cnpj": "33000167000101",
- "correl_ibov": 0.7470931521875993,
- "m9_m21": {
- "value": 1.0042260646940864,
- "trend": 1
}, - "entropy": 0.591727002114042,
- "oplab_score": {
- "ebit_var": 0,
- "revenue_var": 0,
- "cash_var": 1,
- "current_liabilities": 0,
- "mm_signal": 2,
- "date": "2020-12-31",
- "value": 3
}, - "security_category": 11,
- "polynomials_2": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "polynomials_3": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "sector": "PETRÓLEO E GÁS",
- "quotation_form": 100,
- "market_maker": false,
- "highest_options_volume_rank": 2,
- "days_to_maturity": 0,
- "mshort_mlong": {
- "value": 1.0614983633420205,
- "trend": 1
}, - "last_trade_at": 0,
- "long_name": "PETROLEO BRASILEIRO S.A. PETROBRAS",
- "bid_volume": 700,
- "ask_volume": 1400,
- "time": 1620680400000,
- "previous_close": 23.84
}
]Obtém um objeto com os detalhes de uma determiada ação. Além do schema de resposta abaixo, o retorno irá conter os atributos do parâmetro with_financials
| symbol required | string Código de negociação do ativo alvo |
| with_financials | string Enum: "sector" "name" "cvmCode" "currency" "currencyScale" … 9 more Atributos para adicionar no retorno separados por vírgula. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| symbol | string Código de negociação do ativo alvo |
| type | string Tipo do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Value: "VISTA" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ewma_1y_max | number or null Volatilidade EWMA histórica máxima no período de 1 ano |
| ewma_1y_min | number or null Volatilidade EWMA histórica mínima no período de 1 ano |
| ewma_1y_percentile | number or null Percentil da volatilidade EWMA histórica em 1 ano |
| ewma_1y_rank | number or null Classificação da volatilidade EWMA histórica em 1 ano |
| ewma_6m_max | number or null Volatilidade EWMA histórica máxima no período de 6 meses |
| ewma_6m_min | number or null Volatilidade EWMA histórica mínima no período de 6 meses |
| ewma_6m_percentile | number or null Percentil da volatilidade EWMA histórica em 6 meses |
| ewma_6m_rank | number or null Classificação da volatilidade EWMA histórica em 6 meses |
| ewma_current | number Volatilidade EWMA atual |
| has_options | boolean Indica se esta ação tem opções listadas na B3 |
| iv_1y_max | number or null Volatilidade implícita máxima no período de 1 ano |
| iv_1y_min | number or null Volatilidade implícita mínima no período de 1 ano |
| iv_1y_percentile | number or null Percentil da volatilidade implícita em 1 ano |
| iv_1y_rank | number or null Classificação da volatilidade implícita em 1 ano |
| iv_6m_max | number or null Volatilidade implícita máxima no período de 6 meses |
| iv_6m_min | number or null Volatilidade implícita mínima no período de 6 meses |
| iv_6m_percentile | number or null Percentil da volatilidade implícita em 6 meses |
| iv_6m_rank | number or null Classificação da volatilidade implícita em 6 meses |
| iv_current | number Volatilidade implícita atual |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| semi_return_1y | number or null Semi-retorno no período de 1 ano |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
| due_date | string or null <date> Data de vencimento do instrumento |
| maturity_type | string or null Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| parent_symbol | string or null Código de negociação do ativo alvo |
| spot_price | number or null Preço atual do ativo alvo |
| strike | number or null Valor de exercício da opção |
| garch11_1y | number or null Volatilidade conforme modelo GARCH no período de 1 ano |
| isin | string Código ISIN do ativo |
| cnpj | string CNPJ da companhia |
| correl_ibov | number Valor da correlação com o índice IBOV |
object Média móvel de 9 e 21 de dias | |
| entropy | number Medida de incerteza do ativo |
object Score do OpLab baseado em indicadores fundamentalistas | |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| polynomials_2 | object Metodologia do OpLab para calcular o preço de um ativo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| sector | string Setor da companhia |
| quotation_form | integer Tipo de cotação |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| highest_options_volume_rank | integer Classificação do maior volume de opções do dia anterior |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
object Diferença da tendência de curto e médio prazo | |
| last_trade_at | integer or null Timestamp do último negócio |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| previous_close | number Fechamento do dia anterior |
| financial | object or null Objeto contendo os atributos listados no parâmetro |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/stocks/{symbol}?with_financials={with_financials}' \ -H 'Access-Token: {access-token}'
{- "symbol": "PETR4",
- "type": "STOCK",
- "name": "PETROBRAS PN",
- "open": 24.8,
- "high": 24.98,
- "low": 24.58,
- "close": 24.71,
- "volume": 73804500,
- "financial_volume": 1829930000,
- "trades": 0,
- "bid": 24.7,
- "ask": 24.71,
- "category": "VISTA",
- "contract_size": 100,
- "created_at": "2021-05-07T22:03:00.010Z",
- "updated_at": "2021-05-07T22:03:00.010Z",
- "variation": 1.354,
- "ewma_1y_max": 89.61,
- "ewma_1y_min": 49.98,
- "ewma_1y_percentile": 7.94,
- "ewma_1y_rank": 6,
- "ewma_6m_max": 67.19,
- "ewma_6m_min": 49.98,
- "ewma_6m_percentile": 15.87,
- "ewma_6m_rank": 13.82,
- "ewma_current": 52.36,
- "has_options": true,
- "iv_1y_max": 70.89,
- "iv_1y_min": 33.4,
- "iv_1y_percentile": 53.17,
- "iv_1y_rank": 22.38,
- "iv_6m_max": 70.89,
- "iv_6m_min": 35.16,
- "iv_6m_percentile": 53.17,
- "iv_6m_rank": 18.56,
- "iv_current": 41.79,
- "middle_term_trend": 0,
- "semi_return_1y": 1.12,
- "short_term_trend": 0,
- "stdv_1y": 0.030376505142433452,
- "stdv_5d": 0.02673558724536745,
- "beta_ibov": 1.5421326782884273,
- "due_date": null,
- "maturity_type": null,
- "parent_symbol": null,
- "spot_price": null,
- "strike": null,
- "garch11_1y": 50.59,
- "isin": "BRPETRACNPR6",
- "cnpj": "33000167000101",
- "correl_ibov": 0.7470931521875993,
- "m9_m21": {
- "value": 1.0042260646940864,
- "trend": 1
}, - "entropy": 0.591727002114042,
- "oplab_score": {
- "ebit_var": 0,
- "revenue_var": 0,
- "cash_var": 1,
- "current_liabilities": 0,
- "mm_signal": 2,
- "date": "2020-12-31",
- "value": 3
}, - "security_category": 11,
- "polynomials_2": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "polynomials_3": {
- "CALL": {
- "2021-05-21": [
- -197.87301754369594,
- 881.4414805485715,
- -1204.1224827826152,
- 563.4081586463338
]
}, - "PUT": {
- "2022-01-21": [
- -9080.186541670959,
- 27611.279527513467,
- -27963.56272199735,
- 9468.812733317849
]
}
}, - "sector": "PETRÓLEO E GÁS",
- "quotation_form": 100,
- "market_maker": false,
- "highest_options_volume_rank": 2,
- "days_to_maturity": 0,
- "mshort_mlong": {
- "value": 1.0614983633420205,
- "trend": 1
}, - "last_trade_at": 0,
- "bid_volume": 700,
- "ask_volume": 1400,
- "time": 1620680400000,
- "previous_close": 23.84
}Obtém uma lista com todas as opções de um determinado ativo
| symbol required | string Código da ação da companhia |
| symbol | string Código de negociação da opção |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Enum: "CALL" "PUT" Categoria do instrumento |
| due_date | string <date> Data de vencimento do instrumento |
| maturity_type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| strike | number Valor de exercício da opção |
| contract_size | integer Tamanho do contrato mínimo |
| exchange_id | string Value: "BOVESPA" Sigla da responsável pela negociação |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| spot_price | number Preço do ativo alvo no momento da última negociação da opção |
| isin | string Código ISIN do ativo |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| block_date | string <date-time> Data de bloqueio do instrumento |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| cnpj | string CNPJ da companhia |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| type | string Enum: "CALL" "PUT" Tipo de opção |
| last_trade_at | integer Timestamp do último negócio |
| strike_eod | number Valor de exercício da opção |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/options/{symbol}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETRE100",
- "name": "PETROBRAS ON R$ 9.21 21-05-2021",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0,
- "financial_volume": 0,
- "trades": 0,
- "bid": 0.02,
- "ask": 0,
- "category": "CALL",
- "due_date": "2021-05-21",
- "maturity_type": "AMERICAN",
- "strike": 9.21,
- "contract_size": 100,
- "exchange_id": "BOVESPA",
- "created_at": "2021-05-07T22:03:01.160Z",
- "updated_at": "2021-05-07T22:03:01.160Z",
- "variation": 0,
- "spot_price": 23.93,
- "isin": "BRPETR3E05L7",
- "security_category": 7,
- "market_maker": false,
- "block_date": "2021-05-20T00:00:00.000Z",
- "days_to_maturity": 10,
- "cnpj": "33000167000101",
- "bid_volume": 0,
- "ask_volume": 0,
- "time": 1620423900000,
- "type": "CALL",
- "last_trade_at": 1620438635404,
- "strike_eod": 9.21
}
]Obtém um objeto com os detalhes de uma determinada opção
| symbol required | string Código de negociação da opção |
| symbol | string Código de negociação da opção |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| parent_symbol | string Código de negociação do ativo alvo |
| category | string Enum: "CALL" "PUT" Categoria do instrumento |
| due_date | string <date> Data de vencimento do instrumento |
| maturity_type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| strike | number Valor de exercício da opção |
| contract_size | integer Tamanho do contrato mínimo |
| exchange_id | string Value: "BOVESPA" Sigla da responsável pela negociação |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| spot_price | number Preço do ativo alvo no momento da última negociação da opção |
| isin | string Código ISIN do ativo |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| block_date | string <date-time> Data de bloqueio do instrumento |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| cnpj | string CNPJ da companhia |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| type | string Enum: "CALL" "PUT" Tipo de opção |
| last_trade_at | integer Timestamp do último negócio |
| strike_eod | number Valor de exercício da opção |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/options/details/{symbol}' \ -H 'Access-Token: {access-token}'
{- "symbol": "PETRE100",
- "name": "PETROBRAS ON R$ 9.21 21-05-2021",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0,
- "financial_volume": 0,
- "trades": 0,
- "bid": 0.02,
- "ask": 0,
- "parent_symbol": "PETR3",
- "category": "CALL",
- "due_date": "2021-05-21",
- "maturity_type": "AMERICAN",
- "strike": 9.21,
- "contract_size": 100,
- "exchange_id": "BOVESPA",
- "created_at": "2021-05-07T22:03:01.160Z",
- "updated_at": "2021-05-07T22:03:01.160Z",
- "variation": 0,
- "spot_price": 23.93,
- "isin": "BRPETR3E05L7",
- "security_category": 7,
- "market_maker": false,
- "block_date": "2021-05-20T00:00:00.000Z",
- "days_to_maturity": 10,
- "cnpj": "33000167000101",
- "bid_volume": 0,
- "ask_volume": 0,
- "time": 1620423900000,
- "type": "CALL",
- "last_trade_at": 1620438635404,
- "strike_eod": 9.21
}Obtém uma lista das opções com strike menor ou igual ao preço de um ou mais ativos
| underlying | string Example: underlying=PETR4,ABEV3 Códigos das ações das companhias separados por vírgula |
| symbol | string Código de negociação da opção |
| type | string Enum: "CALL" "PUT" Tipo de opção |
| name | string Nome da companhia, valor do strike e data de vencimento da opção |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| parent_symbol | string Código de negociação do ativo alvo |
| category | string Enum: "CALL" "PUT" Categoria do instrumento |
| due_date | string <date> Data de vencimento do instrumento |
| maturity_type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| strike | number Valor de exercício da opção |
| contract_size | integer Tamanho do contrato mínimo |
| exchange_id | string Value: "BOVESPA" Sigla da responsável pela negociação |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| spot_price | number Preço do ativo alvo no momento da última negociação da opção |
| isin | string Código ISIN do ativo |
| security_category | integer Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| block_date | string <date-time> Data de bloqueio do instrumento |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| cnpj | string CNPJ da companhia |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| last_trade_at | integer Timestamp do último negócio |
| strike_eod | number Valor de exercício da opção |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/options/strategies/covered?underlying={underlying}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETRE100",
- "type": "CALL",
- "name": "PETROBRAS ON R$ 9.21 21-05-2021",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "volume": 0,
- "financial_volume": 0,
- "trades": 0,
- "bid": 0.02,
- "ask": 0,
- "parent_symbol": "PETR3",
- "category": "CALL",
- "due_date": "2021-05-21",
- "maturity_type": "AMERICAN",
- "strike": 9.21,
- "contract_size": 100,
- "exchange_id": "BOVESPA",
- "created_at": "2021-05-07T22:03:01.160Z",
- "updated_at": "2021-05-07T22:03:01.160Z",
- "variation": 0,
- "spot_price": 23.93,
- "isin": "BRPETR3E05L7",
- "security_category": 7,
- "market_maker": false,
- "block_date": "2021-05-20T00:00:00.000Z",
- "days_to_maturity": 10,
- "cnpj": "33000167000101",
- "bid_volume": 0,
- "ask_volume": 0,
- "time": 1620423900000,
- "last_trade_at": 1620438635404,
- "strike_eod": 9.21
}
]Obtém um objeto com o preço teórico, as gregas, a volatilidade implícita e a margem teórica de uma determinada opção
| symbol required | string Código de negociação da opção |
| irate required | number Valor da taxa de juros (%) |
| type | string Enum: "CALL" "PUT" Tipo de opção. Obrigatório se o |
| spotprice | number Default: 0 Preço atual do ativo alvo |
| strike | number Default: 0 Valor do strike da opção. Obrigatório se o código de negociação for de uma ação |
| premium | number Default: 0 Valor do prêmio da opção |
| dtm | integer Default: 0 Dias faltantes para o vencimento da opção |
| vol | number Default: 0 Volatilidade implícita da opção |
| duedate | string <date> Data de vencimento da opção. Obrigatório se o código de negociação for de uma ação |
| amount | integer Default: 0 Quantidade de ativos |
| moneyness | string Enum: "OTM" "ITM" "ATM" Distância medida entre a razão do strike com o spot_price |
| price | number or null Preço teórico da opção baseado no modelo Black and Scholes |
| delta | number Indica quanto o prêmio pode variar a cada 1 unidade de variação do preço do ativo alvo |
| gamma | number Indica quanto irá variar o delta a cada 1 unidade de variação do preço do ativo alvo (aceleração do delta da opção) |
| vega | number Indica quanto o prêmio pode variar a cada 1% de variação da volatilidade |
| theta | number Indica quanto o prêmio pode variar com a passagem de 1 dia |
| rho | number Indica quanto o premio pode variar para cada variação de 1% na taxa de juros |
| volatility | number Volatilidade implícita da opção |
| poe | number or null Probabilidade de exercício segundo a fórmula do BS |
| spotprice | number Preço atual do ativo alvo |
| strike | number Valor de exercício da opção |
| margin | number Valor do strike multiplicado pelo amount informado |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/options/bs?symbol={symbol}&irate={irate}&type={type}&spotprice={spot_price}&strike={strike}&premium={premium}&dtm={dtm}&vol={vol}&duedate={due_date}&amount={amount}' \ -H 'Access-Token: {access-token}'
{- "moneyness": "OTM",
- "price": 0.0317,
- "delta": 0.03,
- "gamma": 0.0254,
- "vega": 0.0033,
- "theta": -0.0096,
- "rho": 0.0003,
- "volatility": 0,
- "poe": 2.37,
- "spotprice": 24.06,
- "strike": 30,
- "margin": 3000
}Obtém uma lista com os principais pozinhos
| symbol | string Código de negociação da opção |
| close | number Último preço |
| strike | number Valor de exercício da opção |
| variation | number Variação percentual de preço no dia |
| volume | integer Volume de negócios do dia |
| financial-volume | integer Volume financeiro do dia |
| spot-symbol | string Código de negociação do ativo alvo |
| spot-price | number Preço atual do ativo alvo |
| spot-volatility | number Volatilidade histórica atual da opção |
| bid | number Melhor oferta de compra |
| bid-volume | integer Volume da melhor oferta de compra |
| ask | number Melhor oferta de venda |
| ask-volume | number Volume da melhor oferta de venda |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| series_id | string ID da série de opções |
| series_name | string Nome da série de opções |
| due-date | string <date> Data de vencimento do instrumento |
| days-to-maturity | integer Dias faltantes para o vencimento da opção |
| type | string Enum: "CALL" "PUT" Tipo de opção |
| maturity-type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| interest-rate | number Taxa de juros SELIC atual (%) |
| market-maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| ewma_current | number Volatilidade EWMA atual |
| contract_size | integer Tamanho do contrato mínimo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| last_trade_at | integer or null Timestamp do último negócio |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/options/powders' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "ABEVQ150",
- "close": 0.02,
- "strike": 15.07,
- "variation": -33.333,
- "volume": 2779,
- "financial-volume": 2779,
- "spot-symbol": "ABEV3",
- "spot-price": 16.88,
- "spot-volatility": 34.18,
- "bid": 0.01,
- "bid-volume": 6900,
- "ask": 0.02,
- "ask-volume": 18000,
- "open": 0.02,
- "high": 0.03,
- "low": 0.01,
- "series_id": "ABEVQ",
- "series_name": "ABEVQ",
- "due-date": "2021-05-21",
- "days-to-maturity": 7,
- "type": "PUT",
- "maturity-type": "EUROPEAN",
- "interest-rate": 3.4000915787165464,
- "market-maker": true,
- "ewma_current": 22.04,
- "contract_size": 100,
- "polynomials_3": {
- "CALL": null,
- "PUT": null
}, - "last_trade_at": null
}
]Obtém uma lista com a cotação de um ou mais instrumentos
| tickers required | string Example: tickers=PETR4,PETRE100 Código de negociação dos instrumentos separados por vírgula |
| symbol | string Código de negociação do instrumento |
| close | number Último preço |
| strike | number Valor de exercício da opção |
| variation | number Variação de preço no dia (%) |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/quote?tickers={tickers}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETR4",
- "close": 29.32,
- "strike": 0,
- "variation": -1.18,
- "volume": 93745300,
- "financial_volume": 2735250760,
- "bid": 29.31,
- "ask": 29.32,
- "bid_volume": 2900,
- "ask_volume": 200,
- "time": 1664393428685,
- "open": 29.67,
- "high": 29.82,
- "low": 28.58
}
]Obtém uma lista de instrumentos
| expr required | string Example: expr=PETR3,ABEV,MGL Códigos de negociação ou nomes da companhia para pesquisa separados por vírgula, podem ser informados valores parciais |
| limit | number Default: 10 Quantidade máxima de itens na lista |
| type | string Default: "STOCK,OPTION" Enum: "STOCK" "OPTION" "INDEX" "REAL_ESTATE_FUND" "INDICATOR" … 2 more Tipos de instrumento para pesquisa separados por vírugla |
| has_options | boolean Default: false Indica se o instrumento deve ter opções listadas na B3 |
| category | string Enum: "CALL" "PUT" Tipo de opção a ser filtrada, só é considerado se o type for |
| add_info | boolean Indica se o retorno deve incluir as informações adicionais, que são: |
| symbol | string Código de negociação do instrumento |
| full_name | string Código de negociação do instrumento |
| description | string Nome da companhia |
| exchange | string Enum: "BCB" "BOVESPA" "TESOURO" Sigla da responsável pela negociação |
| ticker | string Código de negociação do instrumento |
| type | string Enum: "VISTA" "CALL" "PUT" "IVX" "EWMAB3" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| financial_volume | integer Volume financeiro do dia |
| parent_symbol | string Código de negociação do ativo alvo |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/instruments/search?expr={expr}&limit={limit}&type={type}&has_options={has_options}&category={category}&add_info={add_info}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "ABEV3",
- "full_name": "ABEV3",
- "description": "ABEV S/A ON",
- "exchange": "BOVESPA",
- "ticker": "ABEV3",
- "type": "VISTA",
- "contract_size": 100,
- "financial_volume": 662227485
}, - {
- "symbol": "MGLU3",
- "full_name": "MGLU3",
- "description": "MAGAZ LUIZA ON",
- "exchange": "BOVESPA",
- "ticker": "MGLU3",
- "type": "VISTA",
- "contract_size": 100,
- "financial_volume": 716129368
}, - {
- "symbol": "PETR3",
- "full_name": "PETR3",
- "description": "PETROBRAS ON",
- "exchange": "BOVESPA",
- "ticker": "PETR3",
- "type": "VISTA",
- "contract_size": 100,
- "financial_volume": 370797434
}
]Obtém um objeto com os dados do instrumento e todas as séries de opções
| symbol required | string Código de negociação do instrumento |
| bs | boolean Um parâmetro booleano para ativar ou desativar o black and scholes. Se fornecido, |
| irate | number <float> Um valor percentual necessário que representa a taxa de juros usada quando |
| symbol | string Código de negociação do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| variation | number Variação de preço no dia (%) |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | string <date-time> Data e hora da última atualização |
| last_trade_at | string or null <date-time> Data e hora do último negócio |
| contract_size | integer Tamanho do contrato mínimo |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| ewma_current | number Volatilidade EWMA atual |
| iv_current | number Volatilidade implícita atual |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
Array of objects Lista com as séries de opções do instrumento |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/instruments/series/{symbol}' \ -H 'Access-Token: {access-token}'
{- "symbol": "PETR4",
- "name": "PETROBRAS PN N2",
- "open": 27.96,
- "high": 28.3,
- "low": 27.07,
- "close": 27.15,
- "variation": -4.06,
- "volume": 117206600,
- "financial_volume": 3239278195,
- "bid": 27.14,
- "ask": 27.15,
- "bid_volume": 2900,
- "ask_volume": 200,
- "time": "2022-11-08T11:00:33.076Z",
- "last_trade_at": null,
- "contract_size": 100,
- "short_term_trend": -1,
- "middle_term_trend": 1,
- "stdv_1y": 0.024787457563999263,
- "ewma_current": 59.57,
- "iv_current": 54.08,
- "beta_ibov": 1.1282387362064599,
- "series": [
- {
- "due_date": "2022-11-18",
- "days_to_maturity": 6,
- "call": "K",
- "put": "W",
- "strikes": [
- {
- "strike": 5.77,
- "call": {
- "symbol": "PETRK221",
- "open": 21.9,
- "high": 21.9,
- "low": 21.9,
- "close": 21.9,
- "bid": 0.01,
- "ask": 0,
- "volume": 100,
- "financial_volume": 2190,
- "variation": -3.43,
- "maturity_type": "AMERICAN",
- "contract_size": 100,
- "market_maker": false,
- "time": "2022-11-08T11:00:31.078Z",
- "category": "CALL",
- "strike": 5.77
}, - "put": {
- "symbol": "PETRW221",
- "open": 0,
- "high": 0,
- "low": 0,
- "close": 0,
- "bid": 0,
- "ask": 0.01,
- "volume": 0,
- "financial_volume": 0,
- "variation": 0,
- "maturity_type": "EUROPEAN",
- "contract_size": 100,
- "market_maker": false,
- "time": "2022-11-08T11:00:30.976Z",
- "category": "PUT",
- "strike": 5.77
}
}
]
}
]
}Obtém um objeto com os dados do instrumento especificado
| symbol required | string Código de negociação do instrumento |
| symbol | string Código de negociação do ativo alvo |
| type | string Value: "STOCK" Tipo do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Value: "VISTA" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ewma_1y_max | number or null Volatilidade EWMA histórica máxima no período de 1 ano |
| ewma_1y_min | number or null Volatilidade EWMA histórica mínima no período de 1 ano |
| ewma_1y_percentile | number or null Percentil da volatilidade EWMA histórica em 1 ano |
| ewma_1y_rank | number or null Classificação da volatilidade EWMA histórica em 1 ano |
| ewma_6m_max | number or null Volatilidade EWMA histórica máxima no período de 6 meses |
| ewma_6m_min | number or null Volatilidade EWMA histórica mínima no período de 6 meses |
| ewma_6m_percentile | number or null Percentil da volatilidade EWMA histórica em 6 meses |
| ewma_6m_rank | number or null Classificação da volatilidade EWMA histórica em 6 meses |
| ewma_current | number Volatilidade EWMA atual |
| has_options | boolean Indica se esta ação tem opções listadas na B3 |
| iv_1y_max | number or null Volatilidade implícita máxima no período de 1 ano |
| iv_1y_min | number or null Volatilidade implícita mínima no período de 1 ano |
| iv_1y_percentile | number or null Percentil da volatilidade implícita em 1 ano |
| iv_1y_rank | number or null Classificação da volatilidade implícita em 1 ano |
| iv_6m_max | number or null Volatilidade implícita máxima no período de 6 meses |
| iv_6m_min | number or null Volatilidade implícita mínima no período de 6 meses |
| iv_6m_percentile | number or null Percentil da volatilidade implícita em 6 meses |
| iv_6m_rank | number or null Classificação da volatilidade implícita em 6 meses |
| iv_current | number Volatilidade implícita atual |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| semi_return_1y | number or null Semi-retorno no período de 1 ano |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
| due_date | string or null <date-time> Data de vencimento do instrumento |
| maturity_type | string or null Tipo de opção |
| parent_symbol | string or null Código de negociação do ativo alvo |
| spot_price | number or null Preço atual do ativo alvo |
| strike | number or null Valor de exercício da opção |
| garch11_1y | number or null Volatilidade conforme modelo GARCH no período de 1 ano |
| isin | string Código ISIN do ativo |
| cnpj | string CNPJ da companhia |
| correl_ibov | number Valor da correlação com o índice IBOV |
object Média móvel de 9 e 21 de dias | |
| entropy | number Medida de incerteza do ativo |
object Score do OpLab baseado em indicadores fundamentalistas | |
| security_category | integer or null Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| polynomials_2 | object Metodologia do OpLab para calcular o preço de um ativo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| sector | string or null Setor da companhia |
| quotation_form | integer Tipo de cotação |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| highest_options_volume_rank | integer Classificação do maior volume de opções do dia anterior |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
object Diferença da tendência de curto e médio prazo | |
| last_trade_at | integer or null Timestamp do último negócio |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| block_date | string or null Data de bloqueio do instrumento |
| previous_close | number Fechamento do dia anterior |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/instruments/{symbol}' \ -H 'Access-Token: {access-token}'
{- "symbol": "XBOV11",
- "type": "STOCK",
- "name": "CAIXAETFXBOVCI",
- "open": 119.06,
- "high": 119.24,
- "low": 118.75,
- "close": 119.24,
- "volume": 20,
- "financial_volume": 2381.6,
- "trades": 0,
- "bid": 119.24,
- "ask": 120,
- "category": "VISTA",
- "contract_size": 100,
- "created_at": "2021-05-13T22:02:28.219Z",
- "updated_at": "2021-05-13T22:02:28.219Z",
- "variation": 0.88,
- "ewma_1y_max": 0,
- "ewma_1y_min": 0,
- "ewma_1y_percentile": 0,
- "ewma_1y_rank": 0,
- "ewma_6m_max": 0,
- "ewma_6m_min": 0,
- "ewma_6m_percentile": 0,
- "ewma_6m_rank": 0,
- "ewma_current": 0,
- "has_options": true,
- "iv_1y_max": 0,
- "iv_1y_min": 0,
- "iv_1y_percentile": 0,
- "iv_1y_rank": 0,
- "iv_6m_max": 0,
- "iv_6m_min": 0,
- "iv_6m_percentile": 0,
- "iv_6m_rank": 0,
- "iv_current": 0,
- "middle_term_trend": 0,
- "semi_return_1y": 1.12,
- "short_term_trend": 0,
- "stdv_1y": 0.014618020836620966,
- "stdv_5d": 0.015270556184849331,
- "beta_ibov": 0.9835461496033165,
- "due_date": null,
- "maturity_type": null,
- "parent_symbol": null,
- "spot_price": null,
- "strike": null,
- "garch11_1y": 23.15,
- "isin": "BRXBOVCTF005",
- "cnpj": "14120533000111",
- "correl_ibov": 0.9901213597986458,
- "m9_m21": {
- "value": 1.0007523389246404,
- "trend": 1
}, - "entropy": 0.3564843588419101,
- "oplab_score": {
- "ebit_var": 0,
- "revenue_var": 0,
- "cash_var": 0,
- "current_liabilities": 0,
- "mm_signal": 0,
- "date": "",
- "value": 0
}, - "security_category": 3,
- "polynomials_2": {
- "CALL": null,
- "PUT": null
}, - "polynomials_3": {
- "CALL": null,
- "PUT": null
}, - "sector": null,
- "quotation_form": 1,
- "market_maker": false,
- "highest_options_volume_rank": 0,
- "days_to_maturity": 0,
- "mshort_mlong": {
- "value": 1.0381993011890245,
- "trend": 1
}, - "last_trade_at": 1621038635404,
- "bid_volume": 2,
- "ask_volume": 5,
- "time": 1621023340000,
- "block_date": null,
- "previous_close": 118.98
}Obtém uma lista com os detalhes de um ou mais instrumentos
| tickers required | string Example: tickers=PETR4,ABEV3 Código de negociação dos instrumentos separados por vírgula |
| symbol | string Código de negociação do ativo alvo |
| type | string Value: "STOCK" Tipo do instrumento |
| name | string Nome da ação listada na B3 |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| trades | integer Quantidade de trades no dia |
| bid | number Melhor oferta de compra |
| ask | number Melhor oferta de venda |
| category | string Value: "VISTA" Categoria do instrumento |
| contract_size | integer Tamanho do contrato mínimo |
| created_at | string <date-time> Data que o objeto foi criado |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ewma_1y_max | number or null Volatilidade EWMA histórica máxima no período de 1 ano |
| ewma_1y_min | number or null Volatilidade EWMA histórica mínima no período de 1 ano |
| ewma_1y_percentile | number or null Percentil da volatilidade EWMA histórica em 1 ano |
| ewma_1y_rank | number or null Classificação da volatilidade EWMA histórica em 1 ano |
| ewma_6m_max | number or null Volatilidade EWMA histórica máxima no período de 6 meses |
| ewma_6m_min | number or null Volatilidade EWMA histórica mínima no período de 6 meses |
| ewma_6m_percentile | number or null Percentil da volatilidade EWMA histórica em 6 meses |
| ewma_6m_rank | number or null Classificação da volatilidade EWMA histórica em 6 meses |
| ewma_current | number Volatilidade EWMA atual |
| has_options | boolean Indica se esta ação tem opções listadas na B3 |
| iv_1y_max | number or null Volatilidade implícita máxima no período de 1 ano |
| iv_1y_min | number or null Volatilidade implícita mínima no período de 1 ano |
| iv_1y_percentile | number or null Percentil da volatilidade implícita em 1 ano |
| iv_1y_rank | number or null Classificação da volatilidade implícita em 1 ano |
| iv_6m_max | number or null Volatilidade implícita máxima no período de 6 meses |
| iv_6m_min | number or null Volatilidade implícita mínima no período de 6 meses |
| iv_6m_percentile | number or null Percentil da volatilidade implícita em 6 meses |
| iv_6m_rank | number or null Classificação da volatilidade implícita em 6 meses |
| iv_current | number Volatilidade implícita atual |
| middle_term_trend | integer Tendência de médio prazo de acordo com o indicador DMI |
| semi_return_1y | number or null Semi-retorno no período de 1 ano |
| short_term_trend | integer Tendência de curto prazo de acordo com o indicador DMI |
| stdv_1y | number or null Desvio padrão dos retornos no período de 1 ano |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| beta_ibov | number Volatilidade do ativo em relação ao mercado |
| due_date | string or null <date-time> Data de vencimento do instrumento |
| maturity_type | string or null Tipo de opção |
| parent_symbol | string or null Código de negociação do ativo alvo |
| spot_price | number or null Preço atual do ativo alvo |
| strike | number or null Valor de exercício da opção |
| garch11_1y | number or null Volatilidade conforme modelo GARCH no período de 1 ano |
| isin | string Código ISIN do ativo |
| cnpj | string CNPJ da companhia |
| correl_ibov | number Valor da correlação com o índice IBOV |
object Média móvel de 9 e 21 de dias | |
| entropy | number Medida de incerteza do ativo |
object Score do OpLab baseado em indicadores fundamentalistas | |
| security_category | integer or null Enum: 0 1 2 3 4 … 45 more enumDescriptions: {"0":"undefined","1":"BDR","2":"COMMON EQUITIES FORWARD","3":"ETF EQUITIES","4":"FORWARD POINTS","5":"FORWARD RATE AGREEMENT","6":"FUNDS","7":"OPTION ON EQUITIES","8":"OPTION ON INDEX","9":"RECEIPTS","10":"ROLLOVER","11":"SHARES","12":"RIGHTS","13":"UNIT","14":"UNIT RECEIPTS","15":"VOLATILITY","16":"INDEX","17":"EXERCISE","18":"FORW/FUT GOLD","20":"FX SWAP","21":"ETF FOREIGN INDEX","22":"ETF FIXED INCOME","23":"WARRANT","25":"IPO - FOLLOW ON","26":"AUCTIONS","30":"BANK CD","31":"LETTER OF CREDIT","32":"CPR","33":"BONDS","34":"PURE GOLD","35":"FIC","36":"INTERNATIONAL BONDS","37":"CASH","38":"DEBENTURES","39":"ADR","40":"CRI (Real state receivable certificates)","41":"CRA (Agribusiness receivable certificates)","42":"LETRAS FINANCEIRAS","43":"PROMISSORY NOTES","50":"ECONOMIC INDICATORS","51":"PRICING CURVES","52":"PRICING SURFACES","53":"Tradable Sec Lending","54":"Sec lending OTC","55":"ETF GOVT BONDS","56":"ETF PRIMARY MARKET GROSS SETTLEMENT","57":"ETF PRIMARY MARKET NET SETTLEMENT","60":"FLEXIBLE EQUITIES FORWARD","70":"FIXED INCOME TRADABLE INSTRUMENT T0","71":"FIXED INCOME TRADABLE INSTRUMENT T1"} Categoria do instrumento |
| polynomials_2 | object Metodologia do OpLab para calcular o preço de um ativo |
| polynomials_3 | object Metodologia do OpLab para calcular o preço de um ativo |
| sector | string or null Setor da companhia |
| quotation_form | integer Tipo de cotação |
| market_maker | boolean Indica se o intrumento possui market-maker (ação de formador de mercado) |
| highest_options_volume_rank | integer Classificação do maior volume de opções do dia anterior |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
object Diferença da tendência de curto e médio prazo | |
| last_trade_at | integer or null Timestamp do último negócio |
| bid_volume | integer Volume da melhor oferta de compra |
| ask_volume | integer Volume da melhor oferta de venda |
| time | integer Timestamp da última atualização |
| block_date | string or null Data de bloqueio do instrumento |
| previous_close | number Fechamento do dia anterior |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/instruments?tickers={tickers}' \ -H 'Access-Token: {access-token}'
{- "symbol": "XBOV11",
- "type": "STOCK",
- "name": "CAIXAETFXBOVCI",
- "open": 119.06,
- "high": 119.24,
- "low": 118.75,
- "close": 119.24,
- "volume": 20,
- "financial_volume": 2381.6,
- "trades": 0,
- "bid": 119.24,
- "ask": 120,
- "category": "VISTA",
- "contract_size": 100,
- "created_at": "2021-05-13T22:02:28.219Z",
- "updated_at": "2021-05-13T22:02:28.219Z",
- "variation": 0.88,
- "ewma_1y_max": 0,
- "ewma_1y_min": 0,
- "ewma_1y_percentile": 0,
- "ewma_1y_rank": 0,
- "ewma_6m_max": 0,
- "ewma_6m_min": 0,
- "ewma_6m_percentile": 0,
- "ewma_6m_rank": 0,
- "ewma_current": 0,
- "has_options": true,
- "iv_1y_max": 0,
- "iv_1y_min": 0,
- "iv_1y_percentile": 0,
- "iv_1y_rank": 0,
- "iv_6m_max": 0,
- "iv_6m_min": 0,
- "iv_6m_percentile": 0,
- "iv_6m_rank": 0,
- "iv_current": 0,
- "middle_term_trend": 0,
- "semi_return_1y": 1.12,
- "short_term_trend": 0,
- "stdv_1y": 0.014618020836620966,
- "stdv_5d": 0.015270556184849331,
- "beta_ibov": 0.9835461496033165,
- "due_date": null,
- "maturity_type": null,
- "parent_symbol": null,
- "spot_price": null,
- "strike": null,
- "garch11_1y": 23.15,
- "isin": "BRXBOVCTF005",
- "cnpj": "14120533000111",
- "correl_ibov": 0.9901213597986458,
- "m9_m21": {
- "value": 1.0007523389246404,
- "trend": 1
}, - "entropy": 0.3564843588419101,
- "oplab_score": {
- "ebit_var": 0,
- "revenue_var": 0,
- "cash_var": 0,
- "current_liabilities": 0,
- "mm_signal": 0,
- "date": "",
- "value": 0
}, - "security_category": 3,
- "polynomials_2": {
- "CALL": null,
- "PUT": null
}, - "polynomials_3": {
- "CALL": null,
- "PUT": null
}, - "sector": null,
- "quotation_form": 1,
- "market_maker": false,
- "highest_options_volume_rank": 0,
- "days_to_maturity": 0,
- "mshort_mlong": {
- "value": 1.0381993011890245,
- "trend": 1
}, - "last_trade_at": 1621038635404,
- "bid_volume": 2,
- "ask_volume": 5,
- "time": 1621023340000,
- "block_date": null,
- "previous_close": 118.98
}Obtém um objeto com o status atual do mercado, sendo o retorno uma das siglas abaixo
P = Pré aberturaA = Abertura (sessão normal)PN = Pré fechamentoN = FechamentoE = Pré abertura do afterR = Abertura AfterNE = Fechamento do afterF = Final| server_time | string <date-time> Data e hora atual do servidor |
| market_status | string Enum: "P" "A" "PN" "N" "E" … 3 more Sigla referente ao status |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/status' \ -H 'Access-Token: {access-token}'
{- "server_time": "2021-05-07T17:49:07-03:00",
- "market_status": "N"
}Obtém uma lista com uma ou mais companhias. Além do schema de resposta abaixo, o retorno irá conter os atributos do parâmetro includes
| symbols required | string Example: symbols=PETR4,ABEV3 Códigos de negociação das ações separados por vírgula |
| includes | string Enum: "type" "name" "open" "high" "low" … 47 more Example: includes=type,name Atributos para adicionar no retorno separados por vírgula. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| symbol | string Código de negociação do ativo alvo |
| cnpj | string CNPJ da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/companies?symbols={symbols}&includes={includes}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETR4",
- "cnpj": "33000167000101"
}
]Obtém uma lista com os ativos com maiores volumes financeiros negociados em opções
| order_by | string Default: "total" Enum: "call" "put" "total" Propriedade pela qual a lista será ordenada (ordenação descrescente). O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| call | number Volume financeiro de opções de Compra (CALL) |
| put | number Volume financeiro de opções de Venda (PUT) |
| total | number Volume financeiro de opções de Compra e Venda (CALL + PUT) |
| symbol | string Código de negociação do ativo alvo |
| name | string Nome da companhia |
| sector | string Setor da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/realtime/highest_options_volume?order_by={order_by}&limit={limit}' \ -H 'Access-Token: {access-token}'
[- {
- "call": 105550105,
- "put": 78926163,
- "total": 184476268,
- "symbol": "VALE3",
- "name": "VALE S.A.",
- "sector": "EXTRAÇÃO MINERAL"
}
]Obtém uma lista com as opções com as maiores taxas de lucro, considerando apenas opções PUT OTM e CALL ITM
| type required | string Enum: "CALL" "PUT" Tipo da opção |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| symbol | string Código de negociação da opção |
| due_date | string <date-time> Data de vencimento do instrumento |
| financial_volume | number Volume financeiro da opção |
| profit_rate_if_excercised | number Taxa de lucro da opção se for exercido (%) |
| type | string Enum: "CALL" "PUT" Tipo da opção |
| underlying | string Código de negociação do ativo alvo |
| updated_at | string <date-time> Data da última atualização dos dados |
| ve_over_strike | number Valor extrínseco da opção |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| strike | number Valor de exercício da opção |
| spot_strike_ratio | number Valor intrínseco da opção |
| name | string Nome da companhia |
| sector | string Setor da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/realtime/best_covered_options_rates/{type}?limit={limit}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "IRBRI600",
- "due_date": "2021-09-17T03:00:00.000Z",
- "financial_volume": 838,
- "profit_rate_if_excercised": 14.285714285714285,
- "type": "CALL",
- "underlying": "IRBR3",
- "updated_at": "2021-05-04T16:10:03.565Z",
- "ve_over_strike": 12.500000000000009,
- "days_to_maturity": 96,
- "strike": 6,
- "spot_strike_ratio": 1.015,
- "name": "IRB - BRASIL RESSEGUROS S.A.",
- "sector": "SEGURADORAS E CORRETORAS"
}
]Obtém uma lista com as opções com as maiores variações de preço
| type required | string Enum: "CALL" "PUT" Tipo da opção |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| symbol | string Código de negociação da opção |
| due_date | string <date-time> Data de vencimento do instrumento |
| financial_volume | number Volume financeiro da opção |
| profit_rate_if_excercised | number Taxa de lucro da opção se for exercido (%) |
| type | string Enum: "CALL" "PUT" Tipo da opção |
| underlying | string Código de negociação do ativo alvo |
| updated_at | string <date-time> Data da última atualização dos dados |
| variation | number Variação percentual de preço no dia |
| ve_over_strike | number Valor extrínseco da opção |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| strike | number Valor de exercício da opção |
| name | string Nome da companhia |
| sector | string Setor da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/realtime/highest_options_variation/{type}?limit={limit}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "IRBRE780",
- "due_date": "2021-05-21T03:00:00.000Z",
- "financial_volume": 142,
- "profit_rate_if_excercised": 28.28947368421052,
- "type": "CALL",
- "underlying": "IRBR3",
- "updated_at": "2021-05-03T13:32:58.487Z",
- "variation": 100,
- "ve_over_strike": 0.2564102564102564,
- "days_to_maturity": 15,
- "strike": 7.8,
- "name": "IRB - BRASIL RESSEGUROS S.A.",
- "sector": "SEGURADORAS E CORRETORAS"
}
]Obtém uma lista com as opções com as maiores tendências de alta ou de baixa, considerando a relação entre a média de 9 e 21 dias
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista, determina se retornará as tendências de alta ou de baixa. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| days | integer Default: 3650 Máximo de dias a partir da última atualização |
| symbol | string Código de negociação do ativo alvo |
| updated_at | string <date-time> Data da última atualização dos dados |
| cnpj | string CNPJ da companhia |
object Média móvel de 9 e 21 de dias | |
| attribute_name | string Nome do atributo |
| short_name | string Nome curto da companhia |
| name | string Nome da companhia |
| sector | string Setor da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/ranking/m9_m21?limit={limit}&sort={sort}&financial_volume_start={financial_volume_start}&days={days}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "FHER3",
- "updated_at": "2021-05-05T23:01:28.158Z",
- "cnpj": "22266175000188",
- "attribute": {
- "value": 1.2308589992272634,
- "trend": 1
}, - "attribute_name": "m9_m21",
- "short_name": "FER HERINGER",
- "name": "FERTILIZANTES HERINGER S.A. - EM RECUPERAÇÃO JUDICIAL",
- "sector": "Petroquímicos e Borracha"
}
]Obtém uma lista com as opções com as maiores ou menores correlações com o IBOV
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista, determina se retornará as maiores ou as menores correlações. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| days | integer Default: 3650 Máximo de dias a partir da última atualização |
| symbol | string Código de negociação do ativo alvo |
| updated_at | string <date-time> Data da última atualização dos dados |
| cnpj | string CNPJ da companhia |
| attribute | number Valor da correlação com o índice IBOV |
| attribute_name | string Nome do atributo |
| short_name | string Nome curto da companhia |
| name | string Nome da companhia |
| sector | string Setor da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/ranking/correl_ibov?limit={limit}&sort={sort}&financial_volume_start={financial_volume_start}&days={days}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "BOVB11",
- "updated_at": "2021-05-05T23:01:28.361Z",
- "cnpj": "32203211000118",
- "attribute": 0.9994329038026675,
- "attribute_name": "correl_ibov",
- "short_name": "ETF BRA IBOV",
- "name": "",
- "sector": ""
}
]Obtém uma lista com as companhias com os maiores ou menores índices do atributo fundamentalista especificado, podendo ser agrupado e retornar os setores com as maiores ou menores médias de índices do atributo fundamentalista especificado
| attribute required | string Enum: "date" "cash_and_equivalents" "ebit" "earnings" "market_cap" … 15 more Atributo fundamentalista. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| group_by | string Value: "sector" Agrupa a classificação pela propriedade informada. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista, determina se retornará os maiores ou menores índices. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| sector | string Setor da companhia |
| name | string Nome da companhia |
| cnpj | string CNPJ da companhia |
| date | string <date> Data da última divulgação de resultados da companhia |
| short_name | string Nome curto da companhia |
| symbol | Array of strings Lista de códigos de ações da companhia |
| symbol_prefix | string Prefixo dos códigos de ações da companhia |
| attribute | string or number Valor do atributo selecionado |
| attribute_name | string Nome do atributo selecionado |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/ranking/{attribute}?group_by={group_by}&limit={limit}&sort={sort}&financial_volume_start={financial_volume_start}' \ -H 'Access-Token: {access-token}'
[- {
- "sector": "GRÁFICAS E EDITORAS",
- "name": "SARAIVA LIVREIROS S.A. - EM RECUPERAÇÃO JUDICIAL",
- "cnpj": "60500139000126",
- "date": "2020-09-30",
- "short_name": "SARAIVA LIVRB",
- "symbol": [
- "SLED11",
- "SLED4",
- "SLED3",
- "SLED12"
], - "symbol_prefix": "SLED",
- "attribute": 3.0007438016528925,
- "attribute_name": "roic"
}
]Obtém uma lista com as ações com os maiores ou menores OpLab scores, podendo ser agrupado e retornar os setores com as maiores ou menores médias do OpLab score
| score_start | integer Default: 0 OpLab score mínimo |
| financial_volume_start | integer Default: 0 Volume financeiro mínimo |
| group_by | string Value: "sector" Agrupa a classificação pela propriedade informada. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| sort | string Default: "asc" Enum: "asc" "desc" Ordenação da lista, determina se retornará os maiores ou menores OpLab scores. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| limit | integer Default: 20 Quantidade máxima de itens na lista |
| symbol | string Código de negociação da opção |
| name | string Nome da companhia |
| financial_volume | number Volume financeiro do dia |
| updated_at | string <date-time> Data da última atualização dos dados |
| cnpj | string CNPJ da companhia |
object Score do OpLab baseado em indicadores fundamentalistas | |
| sector | string Setor da companhia |
| stdv_5d | number Desvio padrão dos retornos no período de 5 dias |
| short_name | string Nome curto da companhia |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/statistics/ranking/oplab_score?score_start={score_start}&financial_volume_start={financial_volume_start}&group_by={group_by}&sort={sort}&limit={limit}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "VIVR3",
- "name": "VIVER INCORPORADORA E CONSTRUTORA S.A.",
- "financial_volume": 7299082,
- "updated_at": "2021-05-18T22:02:17.734Z",
- "cnpj": "67571414000141",
- "oplab_score": {
- "ebit_var": 1,
- "revenue_var": 1,
- "cash_var": 1,
- "current_liabilities": 0,
- "mm_signal": 2,
- "date": "2020-09-30",
- "value": 5
}, - "sector": "Construção Civil Mat. Constr. e Decoração",
- "stdv_5d": 0.11843452952687675,
- "short_name": "VIVER"
}
]Obtém um objeto com a série histórica de um determinado instrumento no período especificado
| symbol required | string Código de negociação do instrumento |
| resolution required | string Default: "1d" Example: 10, 8h, 20d, 4w, 3m, 1y Tempo de intervalo entre os dados contendo um número e uma letra. As letras reconhecidas são: h = hora, d = dia, w = semana, m = mês, y = ano; caso não seja informada nenhuma letra, considera-se minuto |
| from required | string <date-time> Data de início da consulta |
| to required | string <date-time> Data de fim da consulta |
| amount | integer Quantidade de itens de acordo com o período (hora, dia, semana, mês ou ano) |
| raw | boolean Default: false Indica se deve ignorar os dados financeiros, trazendo valores zerados |
| smooth | boolean Default: false Indica se deve preencher valores de |
| df | string Default: "timestamp" Enum: "timestamp" "iso" Formatação da data. O parâmetro é case sensitive, insira o nome do atributo exatamente como está na lista enum |
| symbol | string Código de negociação do instrumento |
| name | string Código de negociação do instrumento |
| resolution | string Tempo de intervalo entre os dados, determinado pelo parâmetro |
Array of objects Lista com série histórica do instrumento |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/historical/{symbol}/{resolution}?from={from}&to={to}&amount={amount}&raw={raw}&smooth={smooth}&df={df}' \ -H 'Access-Token: {access-token}'
{- "symbol": "ABEV3",
- "name": "ABEV3",
- "resolution": "1d",
- "data": [
- {
- "time": 1620615600000,
- "open": 16.15,
- "high": 16.65,
- "low": 16.09,
- "close": 16.5,
- "volume": 29355000,
- "fvolume": 483920915
}, - {
- "time": 1620702000000,
- "open": 16.35,
- "high": 17,
- "low": 16.25,
- "close": 16.87,
- "volume": 25719300,
- "fvolume": 429899032
}
]
}Obtém uma lista com as atualizações das opções do ativo especificado em um determinado período
| spot required | string Código de negociação do ativo alvo |
| from required | string <date> Data de início da consulta |
| to required | string <date> Data de fim da consulta |
| symbol | string Código de negociação da opção a ser listada |
| symbol | string Código de negociação da opção |
| time | string <date-time> Data de referência dos dados |
object Informações do ativo alvo | |
| type | string Enum: "CALL" "PUT" Tipo de opção |
| due_date | string <date> Data de vencimento do instrumento |
| strike | number Valor de exercício da opção |
| premium | number Valor do prêmio da opção |
| maturity_type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| moneyness | string Enum: "OTM" "ITM" "ATM" Distância medida entre a razão do strike com o spot_price |
| delta | number Indica quanto o prêmio pode variar a cada 1 unidade de variação do preço do ativo alvo |
| gamma | number Indica quanto irá variar o delta a cada 1 unidade de variação do preço do ativo alvo (aceleração do delta da opção) |
| vega | number Indica quanto o prêmio pode variar a cada 1% de variação da volatilidade |
| theta | number Indica quanto o prêmio pode variar com a passagem de 1 dia |
| rho | number Indica quanto o premio pode variar para cada variação de 1% na taxa de juros |
| volatility | number Volatilidade implícita da opção |
| poe | number Probabilidade de exercício segundo a fórmula do BS |
| bs | number Preço teórico da opção baseado no modelo Black and Scholes |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/historical/options/{spot}/{from}/{to}?symbol={symbol}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "PETRA230",
- "time": "2021-05-17T00:00:00.000Z",
- "spot": {
- "price": 26.66,
- "symbol": "PETR4"
}, - "type": "CALL",
- "due_date": "2023-01-20T00:00:00.000Z",
- "strike": 22.21,
- "premium": 8.85,
- "maturity_type": "AMERICAN",
- "days_to_maturity": 438,
- "moneyness": "ITM",
- "delta": 0.75,
- "gamma": 0.0192,
- "vega": 0.1128,
- "theta": -0.007,
- "rho": 0.1916,
- "volatility": 47.438,
- "poe": 51.39,
- "bs": 8.85
}
]Obtém uma lista com dados dos instrumentos na data especificada
| tickers required | string Example: tickers=VALEB101,ABEV3 Código de negociação dos instrumentos separados por vírgula |
| date required | string <date> Data da consulta |
| symbol | string Código de negociação do ativo |
| time | string <date-time> Data de referência dos dados |
| open | number Abertura do dia |
| high | number Máxima do dia |
| low | number Mínima do dia |
| close | number Último preço do dia |
| volume | integer Volume de negócios do dia |
| financial_volume | number Volume financeiro do dia |
| ewma_current | number or null Volatilidade EWMA na data |
| parent_symbol | string Código de negociação do ativo alvo |
| spot_price | number Preço do ativo alvo no momento da última negociação da opção |
| categoty | string Enum: "CALL" "PUT" Tipo de opção |
| due_date | string <date> Data de vencimento do instrumento |
| days_to_maturity | integer Dias faltantes para o vencimento da opção |
| strike | number Valor de exercício da opção |
| premium | number Valor do prêmio da opção |
| maturity_type | string Enum: "AMERICAN" "EUROPEAN" Tipo de opção |
curl -i -X GET \ 'https://api.oplab.com.br/v3/market/historical/instruments?tickers={tickers}&date={date}' \ -H 'Access-Token: {access-token}'
[- {
- "symbol": "VALEB101",
- "time": "2021-02-01T00:00:00.000Z",
- "open": 0.7,
- "high": 0.78,
- "low": 0.54,
- "close": 0.78,
- "volume": 2176300,
- "financial_volume": 1396252,
- "ewma_current": null,
- "parent_symbol": "VALE3",
- "spot_price": 91.27,
- "category": "CALL",
- "due_date": "2021-02-22T00:00:00.000Z",
- "days_to_maturity": 15,
- "strike": 101.24,
- "premium": 0.78,
- "maturity_type": "AMERICAN"
}, - {
- "symbol": "ABEV3",
- "time": "2021-02-01T03:00:00.000Z",
- "open": 14.850093811865086,
- "high": 15.17880682592981,
- "low": 14.714741394309026,
- "close": 15.082126527675479,
- "volume": 22235900,
- "financial_volume": 333529289.1095118,
- "ewma_current": 33.736162905273
}
]