B3 (Brasil Bolsa Balcão)

B3 Authentication APIs

OAuth 2.0 token issuance APIs used across the B3 API catalog - Client Credentials flows (plain, plus category_ID, key, or scope parameter variants) and Resource Owner Password Credentials flows.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.b3.com.br/apis/autenticacao

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/openapi/b3-exchange-auth-client-credentials-openapi.json
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/openapi/b3-exchange-auth-ropc-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/overlays/b3-exchange-auth-client-credentials-overlay.yaml
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/overlays/b3-exchange-auth-ropc-overlay.yaml

OpenAPI Specification

b3-exchange-auth-client-credentials-openapi.json Raw ↑ 
{"id":"0af0066c-225c-4e97-964d-c414fe8530e3","description":"API para autentica\u00e7\u00e3o de aplica\u00e7\u00f5es clientes usando o fluxo de autentica\u00e7\u00e3o Client Credentials do OAuth 2.0.","deprecated":false,"apiVersion":"1.0","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/aapi","models":{},"consumes":[],"produces":[],"authorizations":{},"name":"Modelo Client Credentials","summary":"API para autentica\u00e7\u00e3o de aplica\u00e7\u00f5es clientes usando o fluxo de autentica\u00e7\u00e3o Client Credentials do OAuth 2.0.","securityProfile":{"devices":[]},"basePaths":["https:\/\/developers.b3.com.br:8065"],"state":"published","cors":true,"expired":false,"retirementDate":0,"retired":false,"tags":{"Grupo":["AUTENTICACAO"]},"availableApiDefinitions":{"Swagger 1.1":"\/discovery\/swagger\/api\/id\/0af0066c-225c-4e97-964d-c414fe8530e3?swaggerVersion=1.1&filename=Modelo%2BClient%2BCredentials.json","Swagger 2.0":"\/discovery\/swagger\/api\/id\/0af0066c-225c-4e97-964d-c414fe8530e3?swaggerVersion=2.0&filename=Modelo%2BClient%2BCredentials.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/0af0066c-225c-4e97-964d-c414fe8530e3\/ios-swift","android":"\/discovery\/sdk\/0af0066c-225c-4e97-964d-c414fe8530e3\/android","nodejs":"\/discovery\/sdk\/0af0066c-225c-4e97-964d-c414fe8530e3\/nodejs"},"apis":[{"path":"\/aapi\/oauth\/token","name":"\/oauth\/token","operations":[{"id":"c4710c59-3053-4a40-adb1-795d3b46aa9a","description":"","httpMethod":"POST","nickname":"POST","notes":"Este endpoint tem a finalidade obter o token autoriza\u00e7\u00e3o para acesso as APIs de neg\u00f3cio.","responseClass":"void","errorResponses":[{"code":200,"reason":"OK"},{"code":401,"reason":"Unauthorized"}],"consumes":["application\/x-www-form-urlencoded"],"produces":[],"tags":{},"securityProfile":{"devices":[]},"cors":true,"parameters":[{"description":"Client_ID recebido no arquivo chamado de \"pacote de acesso\". Essa informa\u00e7\u00e3o est\u00e1 disponivel no arquivo \"#_client_id_secret.txt\". Para uso no cen\u00e1rio de mock no portal B3ForDevelopers utilize o conte\u00fado \"1df059ec-3090-4429-a229-176388b174ed\"","required":true,"name":"client_id","dataType":"string","paramType":"form","allowMultiple":false},{"description":"Client_Secret recebido no arquivo chamado de \"pacote de acesso\". Essa informa\u00e7\u00e3o est\u00e1 disponivel no arquivo \"#_client_id_secret.txt\". Para uso no cen\u00e1rio de mock no portal B3ForDevelopers utilize o conte\u00fado \"6c20c9b8-97d3-4362-bc35-4dd0c85dbe89\"","required":true,"name":"client_secret","dataType":"string","paramType":"form","allowMultiple":false},{"description":"Valor fixo \"client_credentials\"","required":true,"name":"grant_type","dataType":"string","paramType":"form","allowMultiple":false}]}]}],"createDate":1718056880494,"accessGrantedDate":1718916524277,"type":"rest","enableInlineTryIt":true}