B3 OTC (Balcão) APIs

{"id":"7f2c12f0-3586-4c1d-afb9-3d2a0a445eff","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\r\n\r\nA seguir s\u00e3o descritos o conjunto de defini\u00e7\u00f5es da API desenvolvida pela B3 que ser\u00e3o utilizadas no processo de consulta de Informa\u00e7\u00f5es P\u00fablicas relacionadas ao sistema NOME Balc\u00e3o.\r\n\r\nAs APIs WEB possibilitam aos participantes do servi\u00e7o consultar as informa\u00e7\u00f5es p\u00fablicas relacionadas ao sistema NOME, conforme a seguir:\r\n\r\n- Consulta de Dom\u00ednios, Curvas, Feeders e Moedas, retornando os seus c\u00f3digos internos e respectivas descri\u00e7\u00f5es. O resultado dessa API pode variar conforme o ambiente, testes x produ\u00e7\u00e3o, de tal forma que nem todos os c\u00f3digos de um ambiente necessariamente existir\u00e3o em outro, e nem todos os dom\u00ednios existentes entre os dois ambientes ter\u00e3o o mesmo c\u00f3digo;\r\n\r\n- Consulta das combina\u00e7\u00f5es de Tipos de Produtos x Forma de Acondicionamento x Unidades de Medida, formando Cestas de Produtos. Em APIs de Registro Altera\u00e7\u00e3o de Instrumentos Financeiros Agr\u00edcolas, como CPR, \u00e9 necess\u00e1rio informar uma combina\u00e7\u00e3o v\u00e1lida entre esses dados que comp\u00f5em o cadastro do Produto, e essa API retorna justamente as combina\u00e7\u00f5es poss\u00edveis. Cada ambiente, teste e produ\u00e7\u00e3o, pode retornar combina\u00e7\u00f5es diferentes.\r\n\r\nConstru\u00eddas no padr\u00e3o REST, consistem em um conjunto de URL\u2019s que viabilizam a realiza\u00e7\u00e3o de coleta e envio de mensagens executadas por sistema.\r\n\r\nNessa p\u00e1gina ser\u00e1 informada toda a documenta\u00e7\u00e3o necess\u00e1ria para as APIs public-infos, que possibilitam conex\u00f5es diretas entre os sistemas dos participantes e a plataforma do sistema NOME.\r\n\r\nA API public-infos utiliza verbos HTTPS em uma arquitetura REST , o que facilita a solicita\u00e7\u00e3o e o recebimento dos mesmos. A autentica\u00e7\u00e3o b\u00e1sica \u00e9 administrada por HTTPS e as respostas s\u00e3o entregues no formato JSON (Java Script Object Notation).\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\nA URL base para acesso aos endpoints deve ser conforme indicado abaixo:\r\n\r\n**Certifica\u00e7\u00e3o:**\r\n- Internet: https:\/\/api-balcao-cert.b3.com.br\/\r\n- RTM: https:\/\/api-balcao-cert.rtm.netb3.com.br\/\r\n\r\n**Produ\u00e7\u00e3o:**\r\n- Internet: https:\/\/api-balcao.b3.com.br\r\n- RTM: https:\/\/api-balcao.rtm.netb3.com.br\/\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=28) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n","deprecated":false,"apiVersion":"1.0.0-rc4","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/public-infos\/v1","models":{"Meta":{"type":"object","required":["totalPages","totalRecords"],"properties":{"totalRecords":{"type":"integer","format":"int32","example":2147483647,"description":"N\u00famero total de registros.","minimum":-2147483648,"maximum":2147483647},"totalPages":{"type":"integer","format":"int32","example":2147483647,"description":"N\u00famero total de p\u00e1ginas.","minimum":-2147483648,"maximum":2147483647}}},"Data2":{"type":"object","required":["interestCurrencies"],"properties":{"interestCurrencies":{"type":"array","items":{"$ref":"#\/definitions\/InterestCurrency"}}}},"ProductBatches1RspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/Data1"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"InterestCurrency":{"type":"object","required":["domainCode","domainDescription","groupName","registrationDate","subGroupName"],"properties":{"groupName":{"type":"string","example":"CURVAS","description":"Classifica\u00e7\u00e3o abrangente do dom\u00ednio, descrevendo a qual grupo de informa\u00e7\u00e3o ele pertence (como Curvas, Dom\u00ednios, Feeders etc.)","maxLength":50},"subGroupName":{"type":"string","example":"Tipo do Indicador do \u00cdndice (VCP)","description":"Classifica\u00e7\u00e3o mais espec\u00edfica do dom\u00ednio, descrevendo com mais exatid\u00e3o ao que esse dom\u00ednio se refere (como Classe Tipo PH, Indicador VCP etc.)","maxLength":50},"domainCode":{"type":"string","example":"6692","description":"C\u00f3digo identificador do dom\u00ednio dentro da B3. \u00c9 este c\u00f3digo que precisa ser informado nos campos de dom\u00ednio nas APIs B3, como por exemplo, no campo cprProductHarvest da API de Registro Altera\u00e7\u00e3o de CPR","maxLength":39},"domainDescription":{"type":"string","example":"IGPM proje\u00e7\u00e3o","description":"Texto descritivo do dom\u00ednio, correlacionando o seu c\u00f3digo de identifica\u00e7\u00e3o com o que ele representa internamente para a B3","maxLength":60},"registrationDate":{"type":"string","format":"date","example":"11\/11\/2016","description":"Data em que este dom\u00ednio foi inclu\u00eddo na B3"}}},"ProductBatch":{"type":"object","required":["measureUnitName","packagingWayName","productTypeName"],"properties":{"productTypeName":{"type":"string","example":"ARROZ","description":"Nome Descritivo do Tipo do Produto. Corresponde, por exemplo, ao campo cprProductName da API de Registro Altera\u00e7\u00e3o de CPR","maxLength":100},"measureUnitName":{"type":"string","example":"QUILO","description":"Unidade de medida do produto. Corresponde, por exemplo, ao campo measureUnitName da API de Registro Altera\u00e7\u00e3o de CPR","maxLength":40},"packagingWayName":{"type":"string","example":"SACA 60KG","description":"Forma como o produto ser\u00e1 armazenado. Corresponde, por exemplo, ao campo packagingWayName da API de Registro Altera\u00e7\u00e3o de CPR","maxLength":30}}},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","example":"accusamus","description":"C\u00f3digo do erro de neg\u00f3cio.","maxLength":10},"title":{"type":"string","example":"vel","description":"Mensagem sucinta do erro de neg\u00f3cio.","maxLength":100},"detail":{"type":"string","example":"repellat","description":"Informa\u00e7\u00f5es complementares sobre o erro.","maxLength":2000}}},"Data1":{"type":"object","required":["productBatches"],"properties":{"productBatches":{"type":"array","items":{"$ref":"#\/definitions\/ProductBatch"}}}},"InterestCurrencies2RspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/Data2"},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"Link":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"et","description":"Link para a p\u00e1gina atual.","maxLength":2000},"first":{"type":"string","example":"eligendi","description":"Link para a primeira p\u00e1gina.","maxLength":2000},"prev":{"type":"string","example":"consequatur","description":"Link para a p\u00e1gina anterior.","maxLength":2000},"next":{"type":"string","example":"ipsa","description":"Link para a pr\u00f3xima p\u00e1gina.","maxLength":2000},"last":{"type":"string","example":"minus","description":"Link para a \u00faltima p\u00e1gina.","maxLength":2000}}},"errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}}},"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":"Public-Info","summary":"Essa api far\u00e1 a consulta de Informa\u00e7\u00f5es P\u00fablicas relacionadas ao sistema NoMe Balc\u00e3o","securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"basePaths":["https:\/\/developers.b3.com.br:8065"],"state":"published","cors":true,"expired":false,"retirementDate":0,"retired":false,"tags":{"Tipo":["PUBLICA"],"Grupo":["BALCAO"]},"availableApiDefinitions":{"Swagger 1.1":"\/discovery\/swagger\/api\/id\/7f2c12f0-3586-4c1d-afb9-3d2a0a445eff?swaggerVersion=1.1&filename=Public-Info.json","Swagger 2.0":"\/discovery\/swagger\/api\/id\/7f2c12f0-3586-4c1d-afb9-3d2a0a445eff?swaggerVersion=2.0&filename=Public-Info.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/7f2c12f0-3586-4c1d-afb9-3d2a0a445eff\/ios-swift","android":"\/discovery\/sdk\/7f2c12f0-3586-4c1d-afb9-3d2a0a445eff\/android","nodejs":"\/discovery\/sdk\/7f2c12f0-3586-4c1d-afb9-3d2a0a445eff\/nodejs"},"apis":[{"path":"\/api\/public-infos\/v1\/product-batches","name":"\/product-batches","operations":[{"id":"578c0a8d-14fc-4ffd-86fc-ef12e1b0700e","description":"","httpMethod":"GET","nickname":"ProductBatches1ReqGet","summary":"Esse endpoint retornar\u00e1 as combina\u00e7\u00f5es de Tipos de Produtos x Forma de Acondicionamento x Unidades de Medida, formando Cestas de Produtos. Em APIs de Registro Altera\u00e7\u00e3o de Instrumentos Financeiros Agr\u00edcolas, como CPR, \u00e9 necess\u00e1rio informar uma combina\u00e7\u00e3o v\u00e1lida entre esses dados que comp\u00f5em o cadastro do Produto, e essa API retorna justamente as combina\u00e7\u00f5es poss\u00edveis. Cada ambiente (teste   produ\u00e7\u00e3o) pode retornar combina\u00e7\u00f5es diferentes.","responseClass":"ProductBatches1RspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/api\/public-infos\/v1\/interest-currencies\/{tickerSymbolTypeCode}","name":"\/interest-currencies\/{tickerSymbolTypeCode}","operations":[{"id":"37e5ec4f-6b9e-438c-a6a0-c422a65bc830","description":"","httpMethod":"GET","nickname":"InterestCurrencies2ReqGet","summary":"Esse endpoint far\u00e1 a consulta de Dom\u00ednios, Curvas, Feeders e Moedas, retornando os seus c\u00f3digos internos e respectivas descri\u00e7\u00f5es. O resultado dessa API pode variar conforme o ambiente (testes x produ\u00e7\u00e3o), de tal forma que nem todos os c\u00f3digos de um ambiente necessariamente existir\u00e3o em outro, e nem todos os dom\u00ednios existentes entre os dois ambientes ter\u00e3o o mesmo c\u00f3digo ","responseClass":"InterestCurrencies2RspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"N\u00famero da p\u00e1gina solicitada (o valor da primeira p\u00e1gina \u00e9 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"N\u00famero total de registros por p\u00e1gina.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false},{"description":"C\u00f3digo do Tipo do Instrumento Financeiro","required":true,"maxLength":5,"name":"tickerSymbolTypeCode","dataType":"string","paramType":"path","allowMultiple":false}]}]}],"createDate":1718997190377,"accessGrantedDate":1718997191946,"type":"rest","enableInlineTryIt":true}