Documentation Powered by ReDoc

OpLab API (2.0)

Download OpenAPI specification:Download

Introdução

A API é uma solução que permite acesso aos dados de informações relacionadas ao aplicativo Oplab, onde você possui o acesso ao portfólio, gráficos, posições, entre outras informações. Ela é de uso individual, os dados obtidos pela API não pode ser distribuidos sem prévia autorização e seu uso está vinculada aos termos de serviços da Oplab que pode ser obtido no rodapé do website ou neste link direto https://www.oplab.com.br/termos-de-servico

Autenticação

Para fazer as chamadas na API, é necessário que você esteja autenticado com sua conta do Oplab. Estar autenticado, significa passar um header do tipo Access-Token em cada request.

Uma vez que você já possua cadastro no Oplab, existem duas formas para se obter esse Access-Token:


Via HTTP Request
"curl -X post -d '{"email": "exemplo@exemplo.com.br", "password": "exemplo123"}' https://api.oplab.com.br/v2/users/authenticate"

O Access-Token tem TTL de 2 semanas. Após esse período, será necessário renová-lo com 

curl -X GET -H 'Access-Token: P85w4/j6vYELJpQdRI9JtLhGxpvj2aAqVmB5ARnLHFnRS6wg9USK/+aWm2WTcj7N6ovN8pgPQH6uQVUkQBsXGQ==--TCJMJ5UFzrkb91z21smXw==--YpYFE5c+anh2+xfMBjIrSQ==' 'https://api.oplab.com.br/v2/users/authorize'

Pessoas

Autorização

Request body description

header Parameters
Access Token
required
string
Example: P85w4/j6vYELJpQdRI9JtLhGxAYGIaDGYADgAY7FA7Y7SdUASAdsfafUASHUASHaSUHIugruhe

Responses

200

OK

get/users/authorize
https://api.oplab.com.br/users/authorize

Request samples

Copy
curl -i -X GET -H 'Access-Token: YOUR ACCESS TOKEN' 'https://api.oplab.com.br/v2/users/authorize'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Desenvolvedor Oplab",
  • "id": 10518,
  • "preferences": { },
  • "email": "dev@oplab.com.br",
  • "last-login": "2019-03-26T00:35:02.243Z",
  • "category": "MAX",
  • "access-token": "tupYCgGeXK441+jaRX+owrVt1Rp2d+jBAvNoppf4XEB4puIgI2qW2keqByq7e4MqVIMJKTNtDtnVosMJMBmAMA==--uzF4yHkdKNh+M5urrosiVg==--P3I//V6qx7bxNlQhito1QA==",
  • "data-access": "REAL_TIME",
  • "display-name": "Desenvolvedor Oplab",
  • "avatar": "https://www.gravatar.com/avatar/b94552096036bb386ad1d2bc4042f852?d=mm",
  • "versions":
    {
    },
  • "days-to-expiration": 54,
  • "datafeed-access-token": "np7ITttANtKQolkC1ys+FafO3KpGu2PT3ouUr1TA+0bwb7XrDYyRxX6UtP1S2L0df0qD1Cbx/NxUm6tUXtuVbQ==--mCOjry5sgY0l1ynDPeIFBQ==--ZKOM2Kp2aH3KWcX"
}

Autenticação

Endpoint description

header Parameters
Email
required
string
Example: exemplo@exemplo.com.br
Senha
required
string
Example: exemplo123

Responses

200

OK

post/v2/users/authenticate
https://api.oplab.com.br/v2/users/authenticate

Request samples

Copy
curl -i -X POST -d {"email": "exemplo@exemplo.com.br", "password": "exemplo123 "}"https://api.oplab.com.br/v2/users/authenticate"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access-token": "idRiRrQ5+XfCbOq/S0alOSx+Gz5gosvNK9R8838PeP9pc426fD6BzceEWkx20YHJoGXncmaUfVih/CwRx7FXVA==--WCljLkMdPa9PU0/27UDjSQ==--nikje9cSbF0fHtjlaZxahQ==",
  • "avatar": "https://www.gravatar.com/avatar/b94552096036bb386ad1d2bc4042f852?d=mm",
  • "category": "MAX",
  • "data-access": "REAL_TIME",
  • "datafeed-access-token": "M0zRluxYaeL2q2HELb6hrJDS6dG84DJ0l581MFzrdW+F0UPQrqkKb0eov7vp/7D4yi0vK6hGHla1zS8TY3Ymfg==--2ZuhPW2yEvKEo2I+QVD9Jw==--Eyc+GYA7CnCvkt0g5QcD7w==",
  • "days-to-expiration": 49,
  • "display-name": "Desenvolvedor Oplab",
  • "email": "dev@oplab.com.br",
  • "id": "10518,",
  • "last-login": "2019-03-26T00:35:02.243Z",
  • "name": "Desenvolvedor Oplab",
  • "preferences": { },
  • "versions":
    {
    }
}

Atualizar configurações

Endpoint description

header Parameters
Access Token
required
string
Example: P85w4/j6vYELJpQdRI9JtLhGxAYGIaDGYADgAY7FA7Y7SdUASAdsfafUASHUASHaSUHIugruhe
Request Body schema: application/json
spot_symbol
string
brokerage
integer
interest_rate
number
is_notifications_enabled
boolean
name
string
orders_attributes
string

Responses

200

OK

post/v2/users/settings
https://api.oplab.com.br/v2/users/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "preferences":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Análise de Opções

Carregar uma análise de um determinado ativo

Endpoint description

path Parameters
symbol
required
string
header Parameters
Access Token
required
string
Example: P85w4/j6vYELJpQdRI9JtLhGxAYGIaDGYADgAY7FA7Y7SdUASAdsfafUASHUASHaSUHIugruhe

Responses

200

OK

get/v2/studies/:symbol
https://api.oplab.com.br/v2/studies/:symbol

Request samples

Copy
curl -i -X GET -H 'Access-Token: YOUR ACCESS TOKEN' 'https://api.oplab.com.br/v2/studies/:symbol'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 60407,
  • "target": null,
  • "symbol": "PETR4",
  • "time": 1573171237000,
  • "prefix": "PETR",
  • "open": 30.45,
  • "name": "PETROBRAS PN",
  • "high": 30.79,
  • "low": 30.2,
  • "close": 30.65,
  • "volume": 25016600,
  • "variation": -0.81,
  • "financial-volume": 762476177,
  • "iv-1y-min": 25.38,
  • "iv-1y-max": 51.77,
  • "iv-1y-rank": 12.807881773399021,
  • "iv-1y-percentile": 22.22,
  • "iv-6m-min": 25.38,
  • "iv-6m-max": 37.09,
  • "iv-6m-rank": 28.864218616567044,
  • "iv-6m-percentile": 42.06,
  • "iv-current": 28.76,
  • "ewma-1y-min": 28.78,
  • "ewma-1y-max": 54.51,
  • "ewma-1y-rank": 1.91,
  • "ewma-1y-percentile": 1.98,
  • "ewma-6m-min": 28.78,
  • "ewma-6m-max": 41.7,
  • "ewma-6m-rank": 3.8,
  • "ewma-6m-percentile": 3.97,
  • "ewma-current": 29.27,
  • "short-term-trend": -1,
  • "middle-term-trend": 1,
  • "portfolio":
    {
    },
  • "sector": "Petróleo, Gás e Biocombustíveis",
  • "subsector": "Petróleo, Gás e Biocombustíveis",
  • "segment": "Exploração, Refino e Distribuição",
  • "interest-rate-id": "CETIP",
  • "interest-rate": 4.9,
  • "locked-days-to-maturity": -1,
  • "locked-spot-price": -1,
  • "locked-volatility": -1,
  • "ui-settings": "{\"columns\":[{\"colId\":\"_actions\",\"hide\":false,\"aggFunc\":null,\"width\":75,\"pivotIndex\":null,\"pinned\":\"left\",\"rowGroupIndex\":null},{\"colId\":\"symbol\",\"hide\":false,\"aggFunc\":null,\"width\":100,\"pivotIndex\":null,\"pinned\":\"left\",\"rowGroupIndex\":null},{\"colId\":\"moneyness\",\"hide\":false,\"aggFunc\":null,\"width\":60,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"strike\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"close\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"variation\",\"hide\":false,\"aggFunc\":null,\"width\":80,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"financial-volume\",\"hide\":false,\"aggFunc\":null,\"width\":90,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"bid\",\"hide\":false,\"aggFunc\":null,\"width\":50,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"ask\",\"hide\":false,\"aggFunc\":null,\"width\":50,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"implied-volatility\",\"hide\":false,\"aggFunc\":null,\"width\":90,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"bs-price\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"delta\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"gamma\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"theta\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"vega\",\"hide\":false,\"aggFunc\":null,\"width\":72,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"liquidity-level\",\"hide\":false,\"aggFunc\":null,\"width\":60,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"vi\",\"hide\":false,\"aggFunc\":null,\"width\":60,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"ve\",\"hide\":false,\"aggFunc\":null,\"width\":60,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"volume\",\"hide\":false,\"aggFunc\":null,\"width\":90,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"profit-rate\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"protection-rate\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"rho\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"probability-of-exercise\",\"hide\":false,\"aggFunc\":null,\"width\":70,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"open\",\"hide\":false,\"aggFunc\":null,\"width\":50,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"high\",\"hide\":false,\"aggFunc\":null,\"width\":50,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"low\",\"hide\":false,\"aggFunc\":null,\"width\":50,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null},{\"colId\":\"time\",\"hide\":false,\"aggFunc\":null,\"width\":80,\"pivotIndex\":null,\"pinned\":null,\"rowGroupIndex\":null}]}",
  • "series": null,
  • "PETRL_20201221":
    {