B3 (Brasil Bolsa Balcão)
B3 Investor Area (Área do Investidor) APIs

D-1 investor data for authorized fintechs and custodians - investment positions, account transactions, listed-asset buy/sell activity, public offering participation, and provisioned corporate events - under OAuth 2.0 with investor consent flows (STVM request/response authorization).
Documentation GitHub OpenAPI
OpenAPI Specification

{"id":"691d82de-4e9c-4be8-be31-b66fa9bbaa62","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\r\n\r\nPosi\u00e7\u00e3o \u00e9 o extrato do saldo do investidor por ativo descriminado na data de refer\u00eancia, possui tamb\u00e9m informa\u00e7\u00f5es de gravames caso o investidor se enquadre neste caso.\r\n\r\nExemplos de gravames:\r\n\r\n- Bloqueio Judicial\r\n- Garantias\r\n- Reserva t\u00e9cnica\r\n\r\n![``](\/images\/markdown\/b3investidor-posicao_imagem_2.png)\r\n\r\n**OPT-IN OPT-OUT**\r\n\r\nA B3 com o foco no cliente, iniciou um projeto para melhorar a experi\u00eancia dos investidores pessoa f\u00edsica em um portal no qual o usu\u00e1rio poder\u00e1 acompanhar os seus investimentos de forma consolidada e poder\u00e1 compartilhar suas informa\u00e7\u00f5es com terceiros mediante consentimento livre, informado e expresso fornecido e gerido pela B3 na da plataforma.\r\n\r\nO consentimento expresso \u00e9 uma exig\u00eancia legal (Lei do Sigilo Banc\u00e1rio \u2013 LC 105\/2001). Ela permite que a B3 possa compartilhar tais informa\u00e7\u00f5es e tamb\u00e9m servir\u00e1 para atender as regras da Lei Geral de Prote\u00e7\u00e3o de Dados Pessoais (\u201cLGPD\u201d).\r\n\r\nEm paralelo a isto, possibilitar o compartilhamento das informa\u00e7\u00f5es \u00e9 um passo importante para fomentar o desenvolvimento econ\u00f4mico e tecnol\u00f3gico do mercado.\r\n\r\n\r\n**Opt-in**\r\n\r\nPara a B3 disponibilizar as informa\u00e7\u00f5es do investidor, ser\u00e1 necess\u00e1rio que o mesmo informe por meio da ***\u00e1rea logada do investidor, no site da B3***, que est\u00e1 de acordo em disponibilizar os seus dados para a empresa em quest\u00e3o. Isso poder\u00e1 ser feito de forma fluida em uma jornada integrada com os aplicativos e plataformas dispon\u00edveis no mercado, para isso as empresas interessadas em consumir esses dados ter\u00e3o que assinar um contrato com a B3 e ter\u00e3o que se adaptar para aceitar o consentimento dos clientes por meio da plataforma da B3.\r\n\r\n\r\n**Opt-out**\r\n\r\nPara que o consentimento mencionado seja livre e ainda sejam atendidas as exig\u00eancias legais (LGPD e Lei do Sigilo Banc\u00e1rio) \u00e9 imprescind\u00edvel que a B3 forne\u00e7a a possibilidade de o investidor retirar o consentimento dado a qualquer momento. Para tanto, ser\u00e1 necess\u00e1rio que o mesmo informe por meio da ***\u00e1rea logada do investidor, no site da B3***, que n\u00e3o autoriza mais o envio de seus dados para a empresa em quest\u00e3o, com isso suspenderemos o envio dos dados automaticamente.\r\n\r\n![``](\/images\/markdown\/b3investidor-posicao_imagem_1.png)\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Regras e Boas Pr\u00e1ticas<\/b><\/summary><br\/><p>\r\n\r\n\r\nPara garantir a sa\u00fade da nossa plataforma e um acesso justo para todos aconselhamos seguir as orienta\u00e7\u00f5es de boas pr\u00e1ticas de consumo das APIs.\r\n\r\nAs APIs ter\u00e3o como par\u00e2metro de entrada o CPF do investidor e a data de refer\u00eancia do conte\u00fado, sendo assim, os clientes dever\u00e3o implementar solu\u00e7\u00f5es que atendam os seguintes itens:\r\n\r\n- Consultar cada CPF uma vez por dia;\r\n- Buscar os dados somente do per\u00edodo que ainda n\u00e3o tenha sido consultado anteriormente;\r\n- Para as APIs de movimenta\u00e7\u00e3o, fazer as chamadas somente dos produtos em que o investidor tiver posi\u00e7\u00e3o.\r\n- Os dados ser\u00e3o atualizados de segunda a sexta a partir das 23 horas;\r\n- As APIs funcionar\u00e3o 24 horas por dia e 7 dias por semana.\r\n- Faremos o controle de requisi\u00e7\u00f5es por segundo e por institui\u00e7\u00e3o;\r\n\r\nAs APIs ter\u00e3o as seguintes regras de pagina\u00e7\u00e3o:\r\n- Ser\u00e3o 20 itens por p\u00e1gina\r\n- Respostas superiores a 20 itens ser\u00e3o paginadas\r\n\r\nA API tem como caracter\u00edstica os seguintes itens:\r\n- Os campos principais s\u00e3o obrigat\u00f3rios;\r\n- N\u00e3o h\u00e1 busca aproximada para textos;\r\n- O campo referenceDate deve ser informado no formato: AAAA-MM-DD;\r\n- O campo referenceStartDate deve ser informado no formato: AAAA-MM-DD;\r\n- O campo referenceEndDate deve ser informado no formato: AAAA-MM-DD;\r\n- Nenhum dos par\u00e2metros de entrada \u00e9 do tipo lista, dessa forma, n\u00e3o h\u00e1 como pesquisar mais de um documento por chamada;\r\n- N\u00e3o \u00e9 poss\u00edvel selecionar quais campos devem ser retornados;\r\n- Os dados dispon\u00edveis para consulta s\u00e3o a partir de 11\/2019;\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\n- Certifica\u00e7\u00e3o: https:\/\/apib3i-cert.b3.com.br:2443\r\n- Produ\u00e7\u00e3o: https:\/\/investidor.b3.com.br:2443\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\r\n\r\n[Clique aqui](\/index.php?option=com_content&view=article&id=26) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado.\r\n\r\n<\/p><\/details><br\/>","deprecated":false,"apiVersion":"3.3.1-rc2","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/position\/v3","models":{"SecurityLendingPosition":{"type":"object","required":["closingPrice","contractNumber","corporationName","documentNumber","earlySettlementIndicator","expirationDate","issueDate","lenderBorrowerComissionRate","lenderBorrowerRate","markingIndicator","participantDocumentNumber","participantName","productCategoryName","productTypeName","referenceDate","securitiesLendingQuantity","sideLenderBorrowerName","tenderEarlySettlementIndicator","tickerSymbol","updateValue"],"properties":{"documentNumber":{"type":"string","example":"00123456789","description":"N\u00famero do documento ","maxLength":14},"referenceDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de refer\u00eancia da informa\u00e7\u00e3o (Formato : YYYY-MM-DD)"},"productCategoryName":{"type":"string","example":"XXX","description":"Armazena as categorias de cada produto","maxLength":100},"productTypeName":{"type":"string","example":"XXX","description":"Tipos de produtos utilizados em  renda vari\u00e1vel","maxLength":100},"markingIndicator":{"type":"boolean","example":true,"description":"Indica se o investidor possui gravames"},"tickerSymbol":{"type":"string","example":"XXX","description":"C\u00f3digo que identifica um instrumento negociado registrado em bolsa de valores. O s\u00edmbolo \u00e9 uma forma curta e conveniente de identificar um instrumento.","maxLength":35},"corporationName":{"type":"string","example":"XXX","description":"Este campo possui o nome da institui\u00e7\u00e3o.","maxLength":250},"sideLenderBorrowerName":{"type":"string","example":"XXX","description":"Posi\u00e7\u00e3o do Investidor (Tomador ou Doador)","maxLength":50},"participantName":{"type":"string","example":"XXX","description":"Nome do participante (Corretora) ","maxLength":120},"participantDocumentNumber":{"type":"string","example":"nostrum","description":"N\u00famero do documento do participante","maxLength":14},"lenderBorrowerRate":{"type":"number","format":"double","example":1.25,"description":"Taxa do doador ou tomador"},"lenderBorrowerComissionRate":{"type":"number","format":"double","example":1.35,"description":"Taxa de comiss\u00e3o do doador ou tomador"},"securitiesLendingQuantity":{"type":"number","format":"double","example":10,"description":"Quantidade do ativo"},"closingPrice":{"type":"number","format":"double","example":11.5,"description":"Pre\u00e7o de fechamento"},"updateValue":{"type":"number","format":"double","example":12.01,"description":"Valor atualizado"},"issueDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de Registro do Aluguel (Emiss\u00e3o) (Formato : YYYY-MM-DD)"},"expirationDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de vencimento (Formato : YYYY-MM-DD)"},"contractNumber":{"type":"integer","format":"int32","example":123456,"description":"N\u00famero do contrato","minimum":-2147483648,"maximum":2147483647},"tenderEarlySettlementIndicator":{"type":"boolean","example":true,"description":"Indicador Liquida\u00e7\u00e3o Antecipada OPA"},"earlySettlementIndicator":{"type":"boolean","example":true,"description":"Indicador de permiss\u00e3o de liquida\u00e7\u00e3o antecipada"}}},"EquitiesPositionRsp":{"type":"object","required":["Links"],"properties":{"data":{"$ref":"#\/definitions\/DataEquitiesPositionRsp"},"Links":{"$ref":"#\/definitions\/Link"}}},"Call":{"type":"object","properties":{"exercisePrice":{"type":"number","format":"double","example":10.01,"description":"Pre\u00e7o pre-determinado em que o titular de um derivativo vai comprar ou vender um instrumento subjacente."},"referencePrice":{"type":"number","format":"double","example":10,"description":"Fornece pre\u00e7o de refer\u00eancia."},"optionStyle":{"type":"string","example":"incidunt","description":"Especifica como uma op\u00e7\u00e3o pode ser exercida (americana, europeia) - (Op\u00e7\u00e3o)","maxLength":10},"expirationCode":{"type":"string","example":"aut","description":"S\u00e9rie do papel (Op\u00e7\u00e3o)","maxLength":4}}},"ReasonList":{"type":"object","required":["collateralQuantity","counterpartName","reasonName"],"properties":{"reasonName":{"type":"string","example":"XXXXX","description":"Motivo da garantia indispon\u00edvel","maxLength":100,"enum":["PENHOR","CESS\u00c3O\/ ALIENA\u00c7\u00c3O FIDUCI\u00c1RIA","COBERTURA GARANTIAS BTC","GARANTIAS DE DERIVATIVOS","ATIVOS EM GARANTIA FILCB","PETROBRAS - COBERTURA\/GARANTIA","GARANTIAS UTVM","BLOQ. JUDICIAL OU ADMINIS. - AG CUSTODIA","BLOQUEIO ACORDO DE ACIONISTA","BLOQUEIO DE ATIVOS E RECURSOS FINANCEIRO","BLOQUEIOS DE ATIVOS","BLOQUEIO DE VENDA","BLOQUEIO POR SOLICITACAO DE RETIRADA","BLOQUEIO POR SOLICITACAO DO AG. CUSTODIA","BLOQUEIO INSTRUCAO CVM 400","BLOQUEIO DE ATIVOS","RESERVA T\u00c9CNICA"]},"collateralQuantity":{"type":"number","format":"double","example":10,"description":"Quantidade indispon\u00edvel de acordo com o motivo"},"counterpartName":{"type":"string","example":"XXXXX","description":"Contraparte do motivo indisponivel","maxLength":100}}},"TreasuryBondsPosition":{"type":"object","required":["applicationValue","assetDescription","documentNumber","expirationDate","grossAmount","indexShortName","interestRate","isin","markingIndicator","netValue","participantDocumentNumber","participantName","productCategoryName","productTypeName","referenceDate","tickerSymbol","treasuryBondsQuantity","updateValue"],"properties":{"documentNumber":{"type":"string","example":"00123456789","description":"N\u00famero do documento ","maxLength":14},"referenceDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de refer\u00eancia da informa\u00e7\u00e3o (Formato : YYYY-MM-DD)"},"productCategoryName":{"type":"string","example":"XXXXX","description":"Armazena as categorias de cada produto","maxLength":100},"productTypeName":{"type":"string","example":"XXXXX","description":"Tipos de produtos utilizados em  renda fixa","maxLength":100},"markingIndicator":{"type":"boolean","example":true,"description":"Indica se o investidor possui gravames"},"tickerSymbol":{"type":"string","example":"XXXXX","description":"C\u00f3digo que identifica um instrumento negociado registrado em bolsa de valores. O s\u00edmbolo \u00e9 uma forma curta e conveniente de identificar um instrumento.","maxLength":35},"assetDescription":{"type":"string","example":"neque","description":"Nome do t\u00edtulo do tesouro direto","maxLength":100},"participantName":{"type":"string","example":"XXXXX","description":"Nome do participante (Corretora) ","maxLength":120},"participantDocumentNumber":{"type":"string","example":"earum","description":"N\u00famero do documento do participante","maxLength":14},"expirationDate":{"type":"string","format":"date","example":"2020-07-21","description":"Data de vencimento (Formato : YYYY-MM-DD)"},"treasuryBondsQuantity":{"type":"number","format":"double","example":7932879691.38746,"description":"Quantidade do ativo"},"applicationValue":{"type":"number","format":"double","example":10.01,"description":"Valor aplicado"},"updateValue":{"type":"number","format":"double","example":12.01,"description":"Valor atualizado"},"isin":{"type":"string","example":"XXXXX","description":"INTERNATIONAL SECURITIES IDENTIFICATION NUMBER \u2013 \u00c9 uma padroniza\u00e7\u00e3o internacional na codifica\u00e7\u00e3o de t\u00edtulos financeiros, atribuindo a cada ativo um c\u00f3digo \u00fanico de identifica\u00e7\u00e3o. O c\u00f3digo para os t\u00edtulos e valores mobili\u00e1rios brasileiros apresenta a estrutura BR AAAA BBB CC 7, onde a) os dois primeiros caracteres (BR) identificam o c\u00f3digo do BRASIL; b) os quatro caracteres (AAAA) s\u00e3o alfanum\u00e9ricos e identificam o emissor; c) os tr\u00eas caracteres (BBB) s\u00e3o alfanum\u00e9ricos e identificam o tipo de ativo, podendo ter sequ\u00eancia autom\u00e1tica na segunda posi\u00e7\u00e3o (sequ\u00eancia 1) e na terceira posi\u00e7\u00e3o (sequ\u00eancia 2) ou n\u00e3o ter qualquer sequ\u00eancia; d) os dois caracteres (CC) s\u00e3o alfanum\u00e9ricos e identificam a esp\u00e9cie, quando se tratar de a\u00e7\u00f5es, ou representam uma sequ\u00eancia autom\u00e1tica, para identificar cada emiss\u00e3o de t\u00edtulo e valor mobili\u00e1rio, quando se tratar de outras categorias; e e) o \u00faltimo caractere (7) \u00e9 o d\u00edgito de controle.","maxLength":12},"interestRate":{"type":"number","format":"double","example":9551461600.59785,"description":"Taxa em percentual de rentabilidade do ativo"},"indexShortName":{"type":"string","example":"architecto","description":"Nome abreviado do indexador de atualiza\u00e7\u00e3o monet\u00e1ria ou renumera\u00e7\u00e3o  Dom\u00ednio SEM INDICE DI DOLAR-PTAX800  EURO-PTAX800  IGP - M IGP - DI INPC IPCA IPC - M IPC - FIPE INCC - M INCC - DI PREFIXADO SELIC TAXA ANBID TR TJLP TBF","maxLength":10},"grossAmount":{"type":"number","format":"double","example":4062553967.57411,"description":"Valor bruto"},"netValue":{"type":"number","format":"double","example":15.01,"description":"Valor L\u00edquido a receber"}}},"PassiveTip":{"type":"object","properties":{"passiveUnderlyngInstrument":{"type":"string","example":"XXXXX","description":"Ativo ou indexador subjacente da ponta passiva","maxLength":10},"passivePercent":{"type":"number","format":"double","example":6572038288.32636,"description":"Percentual da ponta passiva"},"passiveInterestRate":{"type":"number","format":"double","example":5738826798.31419,"description":"Taxa de juro da ponta passiva"},"passiveValue":{"type":"number","format":"double","example":3624090181.3176,"description":"Valor da ponta passiva"}}},"DataTreasuryBondsPositionRsp":{"type":"object","properties":{"treasuryBondsPositions":{"type":"array","items":{"$ref":"#\/definitions\/TreasuryBondsPosition"}}}},"DataEquitiesPositionRsp":{"type":"object","properties":{"equitiesPositions":{"type":"array","items":{"$ref":"#\/definitions\/EquitiesPosition"}}}},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","example":"dolore","description":"C\u00f3digo do erro de neg\u00f3cio.","maxLength":10},"title":{"type":"string","example":"saepe","description":"Mensagem sucinta do erro de neg\u00f3cio.","maxLength":100},"detail":{"type":"string","example":"voluptatum","description":"Informa\u00e7\u00f5es complementares a respeito do erro de neg\u00f3cio.","maxLength":2000}}},"DerivativesPositionRsp":{"type":"object","required":["Links"],"properties":{"data":{"$ref":"#\/definitions\/DerivativesPositionRspData"},"Links":{"$ref":"#\/definitions\/Link"}}},"DataSecuritiesLendingPositionRsp":{"type":"object","properties":{"securityLendingPositions":{"type":"array","items":{"$ref":"#\/definitions\/SecurityLendingPosition"}}}},"FixedIncomePosition":{"type":"object","required":["assetDescription","availableQuantity","corporationName","documentNumber","expirationDate","fixedIncomeQuantity","issueDate","markingIndicator","participantDocumentNumber","participantName","productCategoryName","productTypeName","referenceDate","tickerSymbol"],"properties":{"documentNumber":{"type":"string","example":"00123456789","description":"N\u00famero do documento ","maxLength":14},"referenceDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de refer\u00eancia da informa\u00e7\u00e3o (Formato : YYYY-MM-DD)"},"productCategoryName":{"type":"string","example":"XXXXX","description":"Armazena as categorias de cada produto","maxLength":100},"productTypeName":{"type":"string","example":"XXXXX","description":"Tipos de produtos utilizados em  renda fixa","maxLength":100},"markingIndicator":{"type":"boolean","example":true,"description":"Indica se o investidor possui gravames"},"tickerSymbol":{"type":"string","example":"XXXXX","description":"C\u00f3digo que identifica um instrumento negociado registrado em bolsa de valores. O s\u00edmbolo \u00e9 uma forma curta e conveniente de identificar um instrumento.","maxLength":35},"corporationName":{"type":"string","example":"XXXXXX","description":"Nome da empresa (Emissor)","maxLength":250},"participantName":{"type":"string","example":"XXXXX","description":"Nome do participante (Corretora) ","maxLength":120},"participantDocumentNumber":{"type":"string","example":"optio","description":"N\u00famero do documento do participante","maxLength":14},"issueDate":{"type":"string","format":"date","example":"2020-07-21","description":"Data de Emiss\u00e3o  (Formato : YYYY-MM-DD)"},"expirationDate":{"type":"string","format":"date","example":"2020-07-21","description":"Data de vencimento (Formato : YYYY-MM-DD)"},"fixedIncomeQuantity":{"type":"number","format":"double","example":2793184103.81998,"description":"Quantidade do ativo"},"updatedUnitPrice":{"type":"number","format":"double","example":12.01,"description":"Pre\u00e7o unit\u00e1rio atualizado"},"applicationValue":{"type":"number","format":"double","example":10.01,"description":"Valor aplicado "},"assetDescription":{"type":"string","example":"pariatur","description":"Nome do t\u00edtulo do tesouro direto","maxLength":100},"updateValue":{"type":"number","format":"double","example":12.01,"description":"Valor atualizado"},"updatedUnitPriceMTM":{"type":"number","format":"double","example":1.01,"description":"Pre\u00e7o unit\u00e1rio atualizado MTM (Metogologia c\u00e1lculo Marca\u00e7\u00e3o a Mercado)"},"updateValueMTM":{"type":"number","format":"double","example":1.01,"description":"Valor atualizado MTM (Metogologia c\u00e1lculo Marca\u00e7\u00e3o a Mercado)"},"indexShortName":{"type":"string","example":"placeat","description":"Nome abreviado do indexador de atualiza\u00e7\u00e3o monet\u00e1ria ou renumera\u00e7\u00e3o  Dom\u00ednio SEM INDICE DI DOLAR-PTAX800  EURO-PTAX800  IGP - M IGP - DI INPC IPCA IPC - M IPC - FIPE INCC - M INCC - DI PREFIXADO SELIC TAXA ANBID TR TJLP TBF","maxLength":10},"fixedIncomeModalityType":{"type":"string","example":"libero","description":"Modalidade do ativo (registrado ou depoistado)","maxLength":15},"availableQuantity":{"type":"number","format":"double","example":29,"description":"Quantidade dispon\u00edvel para usufruto do cliente (vender ou usufruir \u2013 qtde de ativos) "},"unavailableQuantity":{"type":"number","format":"double","example":1,"description":"Quantidade bloqueada para usufruto do cliente (gravames) "},"reasons":{"type":"array","items":{"$ref":"#\/definitions\/ReasonList"}}}},"Put":{"type":"object","properties":{"exercisePrice":{"type":"number","format":"double","example":10.01,"description":"Pre\u00e7o pre-determinado em que o titular de um derivativo vai comprar ou vender um instrumento subjacente."},"referencePrice":{"type":"number","format":"double","example":10,"description":"Fornece pre\u00e7o de refer\u00eancia."},"optionStyle":{"type":"string","example":"culpa","description":"Especifica como uma op\u00e7\u00e3o pode ser exercida (americana, europeia) - (Op\u00e7\u00e3o)","maxLength":10},"expirationCode":{"type":"string","example":"hic","description":"S\u00e9rie do papel (Op\u00e7\u00e3o)","maxLength":4},"coveredUncoveredCollateral":{"type":"string","example":"voluptatem","description":"Garantia coberta ou descoberta"}}},"Reason":{"type":"object","required":["collateralQuantity","counterpartName","reasonName"],"properties":{"reasonName":{"type":"string","example":"XXXXX","description":"Motivo da garantia indispon\u00edvel","maxLength":100,"enum":["PENHOR","CESS\u00c3O\/ ALIENA\u00c7\u00c3O FIDUCI\u00c1RIA","COBERTURA GARANTIAS BTC","GARANTIAS DE DERIVATIVOS","ATIVOS EM GARANTIA FILCB","PETROBRAS - COBERTURA\/GARANTIA","GARANTIAS UTVM","BLOQ. JUDICIAL OU ADMINIS. - AG CUSTODIA","BLOQUEIO ACORDO DE ACIONISTA","BLOQUEIO DE ATIVOS E RECURSOS FINANCEIRO","BLOQUEIOS DE ATIVOS","BLOQUEIO DE VENDA","BLOQUEIO POR SOLICITACAO DE RETIRADA","BLOQUEIO POR SOLICITACAO DO AG. CUSTODIA","BLOQUEIO INSTRUCAO CVM 400","BLOQUEIO DE ATIVOS","RESERVA T\u00c9CNICA"]},"collateralQuantity":{"type":"number","format":"double","example":10,"description":"Quantidade indispon\u00edvel de acordo com o motivo"},"counterpartName":{"type":"string","example":"XXXXX","description":"Contraparte do motivo indisponivel","maxLength":100}}},"FixedIncomePositionRsp":{"type":"object","required":["Links"],"properties":{"data":{"$ref":"#\/definitions\/DataFixedIncomePositionRsp"},"Links":{"$ref":"#\/definitions\/Link"}}},"DerivativesPositionRspData":{"type":"object","properties":{"derivativesPositions":{"type":"array","items":{"$ref":"#\/definitions\/DerivativesPosition"}}}},"DataFixedIncomePositionRsp":{"type":"object","properties":{"fixedIncomePositions":{"type":"array","items":{"$ref":"#\/definitions\/FixedIncomePosition"}}}},"DerivativesPosition":{"type":"object","required":["ajustedQuoted","applicationValue","assetDescription","availableQuantity","baseValue","counterpartName","derivativeQuantity","documentNumber","expirationDate","investorPositionTypeName","markingIndicator","participantDocumentNumber","participantName","productCategoryName","productTypeName","redemptionValue","referenceDate","startDate","tickerSymbol","unavailableQuantity","underlyingInstrument","unitPrice","updateValue"],"properties":{"documentNumber":{"type":"string","example":"00123456789","description":"N\u00famero do documento ","maxLength":14},"referenceDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de refer\u00eancia da informa\u00e7\u00e3o (Formato : YYYY-MM-DD)"},"productCategoryName":{"type":"string","example":"XXXXX","description":"Armazena as categorias de cada produto","maxLength":100},"productTypeName":{"type":"string","example":"XXXXX","description":"Tipos de produtos utilizados ","maxLength":100},"markingIndicator":{"type":"boolean","example":true,"description":"Indica se o investidor possui gravames"},"tickerSymbol":{"type":"string","example":"XXXXX","description":"C\u00f3digo que identifica um instrumento negociado registrado em bolsa de valores. O s\u00edmbolo \u00e9 uma forma curta e conveniente de identificar um instrumento.","maxLength":35},"participantName":{"type":"string","example":"XXXXX","description":"Nome do participante (Corretora) ","maxLength":120},"participantDocumentNumber":{"type":"string","example":"repudiandae","description":"N\u00famero do documento do participante","maxLength":14},"startDate":{"type":"string","format":"date","example":"2020-07-21","description":"Data de inicio (Formato : YYYY-MM-DD)"},"expirationDate":{"type":"string","format":"date","example":"2020-07-21","description":"Data de vencimento (Formato : YYYY-MM-DD)"},"investorPositionTypeName":{"type":"string","example":"XXXXX","description":"Posicao do investidor (Comprador   Vendedor)","maxLength":20},"derivativeQuantity":{"type":"number","format":"double","example":4242324988.92144,"description":"Posicao do investidor (Comprador   Vendedor)"},"updateValue":{"type":"number","format":"double","example":12.01,"description":"Valor atualizado"},"baseValue":{"type":"number","format":"double","example":0,"description":"Valor Base"},"underlyingInstrument":{"type":"string","example":"ad","description":"Nome da Vari\u00e1vel","maxLength":50},"assetDescription":{"type":"string","example":"dolorem"},"counterpartName":{"type":"string","example":"culpa","description":"Contraparte  (Termo)"},"unitPrice":{"type":"number","format":"double","example":9861234182.48111,"description":"Pre\u00e7o unit\u00e1rio"},"ajustedQuoted":{"type":"number","format":"double","example":6901879100.55292,"description":"Pre\u00e7o de ajuste (Futuro)"},"applicationValue":{"type":"number","format":"double","example":1974022682.47917,"description":"Valor aplicado (BOX)"},"redemptionValue":{"type":"number","format":"double","example":4076333085.1162,"description":"Valor do resgate"},"availableQuantity":{"type":"number","format":"double","example":29,"description":"Quantidade dispon\u00edvel para usufruto do cliente (vender ou usufruir \u2013 qtde de ativos) "},"unavailableQuantity":{"type":"number","format":"double","example":1,"description":"Quantidade bloqueada para usufruto do cliente (gravames) "},"contractNumber":{"type":"string","example":"ABCDE","description":"N\u00famero do contrato","maxLength":20},"strikeValue":{"type":"number","format":"double","example":9.99,"description":"Valor do Strike"},"expositionValue":{"type":"number","format":"double","example":9.99,"description":"Valor da Exposi\u00e7\u00e3o"},"knockInValue":{"type":"number","format":"double","example":9.99,"description":"Valor da Barreira a ser Atingido para que o Contrato de Op\u00e7\u00e3o passe a ser ativo"},"knockOutValue":{"type":"number","format":"double","example":9.99,"description":"Valor da Barreira a ser Atingido para que o Contrato de Op\u00e7\u00e3o passe a valer para o Titular"},"activeTips":{"$ref":"#\/definitions\/ActiveTip"},"passiveTips":{"$ref":"#\/definitions\/PassiveTip"},"reasons":{"type":"array","items":{"$ref":"#\/definitions\/Reason"}},"calls":{"$ref":"#\/definitions\/Call"},"puts":{"$ref":"#\/definitions\/Put"}}},"ActiveTip":{"type":"object","properties":{"activeUnderlyngInstrument":{"type":"string","example":"XXX","description":"Ativo ou indexador subjacente da ponta ativa","maxLength":10},"activePercent":{"type":"number","format":"double","example":4266736187.65794,"description":"Percentual da ponta ativa"},"activeInterestRate":{"type":"number","format":"double","example":1044439301.33874,"description":"Taxa de juro da ponta ativa"},"activeValue":{"type":"number","format":"double","example":6071800041.13681,"description":"Valor da ponta ativa"}}},"EquitiesPosition":{"type":"object","required":["administratorName","availableQuantity","closingPrice","distributionIdentification","documentNumber","equitiesQuantity","isin","markingIndicator","participantDocumentNumber","participantName","productCategoryName","productTypeName","referenceDate","tickerSymbol","unavailableQuantity","updateValue"],"properties":{"documentNumber":{"type":"string","example":"00123456789","description":"N\u00famero do documento ","maxLength":14},"referenceDate":{"type":"string","format":"date","example":"2020-01-01","description":"Data de refer\u00eancia da informa\u00e7\u00e3o (Formato : YYYY-MM-DD)"},"productCategoryName":{"type":"string","example":"XXXXX","description":"Armazena as categorias de cada produto","maxLength":100},"productTypeName":{"type":"string","example":"XXXXX","description":"Tipos de produtos utilizados em  renda variavel","maxLength":100},"markingIndicator":{"type":"boolean","example":true,"description":"Indica se o investidor possui gravames"},"tickerSymbol":{"type":"string","example":"XXXXX","description":"C\u00f3digo que identifica um instrumento negociado registrado em bolsa de valores. O s\u00edmbolo \u00e9 uma forma curta e conveniente de identificar um instrumento.","maxLength":35},"corporationName":{"type":"string","example":"XXXXXX","description":"Nome da empresa (Emissor)","maxLength":250},"specificationCode":{"type":"string","example":"XXXXXX","description":"C\u00f3digo de especifica\u00e7\u00e3o das a\u00e7\u00f5es ON, PN, e assim por diante.","maxLength":10},"participantName":{"type":"string","example":"XXXXX","description":"Nome do participante (Corretora) ","maxLength":120},"participantDocumentNumber":{"type":"string","example":"quia","description":"N\u00famero do documento do participante","maxLength":14},"equitiesQuantity":{"type":"number","format":"double","example":8472375898.62631,"description":"Quantidade do ativo"},"closingPrice":{"type":"number","format":"double","example":7930132756.2583,"description":"Pre\u00e7o de fechamento"},"updateValue":{"type":"number","format":"double","example":12.01,"description":"Valor atualizado"},"isin":{"type":"string","example":"XXXXX","description":"INTERNATIONAL SECURITIES IDENTIFICATION NUMBER \u2013 \u00c9 uma padroniza\u00e7\u00e3o internacional na codifica\u00e7\u00e3o de t\u00edtulos financeiros, atribuindo a cada ativo um c\u00f3digo \u00fanico de identifica\u00e7\u00e3o. O c\u00f3digo para os t\u00edtulos e valores mobili\u00e1rios brasileiros apresenta a estrutura BR AAAA BBB CC 7, onde a) os dois primeiros caracteres (BR) identificam o c\u00f3digo do BRASIL; b) os quatro caracteres (AAAA) s\u00e3o alfanum\u00e9ricos e identificam o emissor; c) os tr\u00eas caracteres (BBB) s\u00e3o alfanum\u00e9ricos e identificam o tipo de ativo, podendo ter sequ\u00eancia autom\u00e1tica na segunda posi\u00e7\u00e3o (sequ\u00eancia 1) e na terceira posi\u00e7\u00e3o (sequ\u00eancia 2) ou n\u00e3o ter qualquer sequ\u00eancia; d) os dois caracteres (CC) s\u00e3o alfanum\u00e9ricos e identificam a esp\u00e9cie, quando se tratar de a\u00e7\u00f5es, ou representam uma sequ\u00eancia autom\u00e1tica, para identificar cada emiss\u00e3o de t\u00edtulo e valor mobili\u00e1rio, quando se tratar de outras categorias; e e) o \u00faltimo caractere (7) \u00e9 o d\u00edgito de controle.","maxLength":12},"distributionIdentification":{"type":"string","example":"2147483647","description":"C\u00f3digo de distribui\u00e7\u00e3o do papel Este c\u00f3digo identifica a vers\u00e3o do ativo. O par ISIN + C\u00f3digo de Distribui\u00e7\u00e3o \u00e9 necess\u00e1rio para instrumentos que t\u00eam deposit\u00e1rio, como a\u00e7\u00f5es e ouro. N\u00e3o h\u00e1 distribui\u00e7\u00e3o de derivativos.","maxLength":15},"bookkeeperName":{"type":"string","example":"XXXXXX","description":"Nome do escriturador","maxLength":20},"availableQuantity":{"type":"number","format":"double","example":29,"description":"Quantidade dispon\u00edvel para usufruto do cliente (vender ou usufruir \u2013 qtde de ativos) "},"unavailableQuantity":{"type":"number","format":"double","example":1,"description":"Quantidade bloqueada para usufruto do cliente (gravames) "},"administratorName":{"type":"string","example":"XXXXXX","description":"Nome do administrador","maxLength":50},"participantCode":{"type":"string","example":"XXXXX","description":"C\u00f3digo do participante","maxLength":50},"accountNumber":{"type":"string","example":"XXXXX","description":"C\u00f3digo da Conta","maxLength":50},"reasons":{"type":"array","items":{"$ref":"#\/definitions\/ReasonList"}}}},"TreasuryBondsPositionRsp":{"type":"object","required":["Links"],"properties":{"data":{"$ref":"#\/definitions\/DataTreasuryBondsPositionRsp"},"Links":{"$ref":"#\/definitions\/Link"}}},"errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}},"Link":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"neque","description":"Link para a p\u00e1gina atual.","maxLength":2000},"first":{"type":"string","example":"voluptate","description":"Link para a primeira p\u00e1gina.","maxLength":2000},"prev":{"type":"string","example":"perspiciatis","description":"Link para a p\u00e1gina anterior.","maxLength":2000},"next":{"type":"string","example":"vero","description":"Link para a pr\u00f3xima p\u00e1gina.","maxLength":2000},"last":{"type":"string","example":"ducimus","description":"Link para a \u00faltima p\u00e1gina.","maxLength":2000}}},"SecuritiesLendingPositionRsp":{"type":"object","required":["Links"],"properties":{"data":{"$ref":"#\/definitions\/DataSecuritiesLendingPositionRsp"},"Links":{"$ref":"#\/definitions\/Link"}}}},"consumes":[],"produces":[],"authorizations":{"_default":{"scopes":[{"scope":"resource.WRITE"},{"scope":"resource.READ"}],"grantTypes":{"clientCredentials":{"url":"https:\/\/localhost:8089\/api\/oauth\/token","tokenName":"access_token"}},"type":"oauth2"}},"name":"B3 Investidor - Posi\u00e7\u00e3o","summary":"Dados at\u00e9 D-

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/openapi/b3-exchange-investor-position-openapi.json
B3 Investor Area (Área do Investidor) APIs

Documentation

Specifications

Other Resources

OpenAPI Specification
