{"id":"78646d15-2690-42df-9822-93e2860fe708","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\n\nA **API do Sistema ISIN** tem como objetivo, facilitar os processos dos clientes, provendo acesso a informa\u00e7\u00f5es sobre os c\u00f3digos ISIN, bem como \u00e0s opera\u00e7\u00f5es de manuten\u00e7\u00e3o.\n\nAs opera\u00e7\u00f5es da API est\u00e3o atreladas ao **Solicitante e seus respectivos Emissores**. Assim sendo, para ter acesso aos endpoints \u00e9 necess\u00e1rio que o v\u00ednculo esteja cadastrado no Sistema ISIN. \n\nPara a inclus\u00e3o de novo v\u00ednculo, contate a [Central de Atendimento de Emissores](https:\/\/www.b3.com.br\/pt_br\/produtos-e-servicos\/solucoes-para-emissores\/suporte-emissores\/sobre-o-suporte\/) \n\n**Funcionalidades de Opera\u00e7\u00e3o**\n\n- Inclus\u00e3o e Atualiza\u00e7\u00e3o em Lote\n- Consulta, Atualiza\u00e7\u00e3o e Exclus\u00e3o por indica\u00e7\u00e3o de ISIN espec\u00edfico\n- Consulta por par\u00e2metros opcionais que retornar\u00e3o uma lista de ISIN correspondentes\n- Instru\u00e7\u00e3o para a cria\u00e7\u00e3o de novo ISIN\n\n<\/p><\/details><br\/>\n\n<details><summary><b>Regras e Boas Pr\u00e1ticas<\/b><\/summary><br\/><p>\n\n\nSegue lista com os dom\u00ednios v\u00e1lidos utilizados na API ISIN:<\/b><\/summary><br\/><p>\n\n\n**assetCode**\n\n - CCB (C\u00e9dula de Cr\u00e9dito Banc\u00e1rio\n - CCIM (C\u00e9dula de Cr\u00e9dito Imobili\u00e1rio)\n - CDB (Certificado de Dep\u00f3sito Banc\u00e1rio)\n - COE (Certificados de Opera\u00e7\u00f5es Estruturadas)\n - DI (Dep\u00f3sito Interfinanceiro)\n - DPGE (Dep\u00f3sito A Prazo com Garantia Especial do FGC)\n - LC (Letra de C\u00e2mbio)\n - LCA (Letras de Cr\u00e9dito Agroneg\u00f3cio)\n - LCI (Letra de Cr\u00e9dito Imobili\u00e1rio)\n - LF (Letra Financeira)\n - LH (Letra Hipotec\u00e1ria)\n - LIG (Letra Imobili\u00e1ria Garantida)\n - RDB (Recibo de Dep\u00f3sito Banc\u00e1rio)\n - SOY (Futuro de Soja Fob Santos com Liquida\u00e7\u00e3o Financeira)\n\n**deliveryTypeCode**\n\n- P (F\u00edsica)\n- C (Financeira)\n\n**dueDateTypeCode**\n\n- P (Perp\u00e9tuo)\n- F (Vencimento Fixo)\n- G (Resgate Antecipado)\n- A (Plano de Amortiza\u00e7\u00e3o)\n- B (Plano de Amortiza\u00e7\u00e3o com Resgate Antecipado)\n- Q (Perp\u00e9tuo com Op\u00e7\u00e3o de Resgate)      \n\n**emissionTypeCode**\n\n- D (Emiss\u00e3o Dom\u00e9stica)\n- I (Emiss\u00e3o Internacional)   \n\n**exerciseTypeCode**\n\n- A (Americana)\n- E (Europeia)\n\n**guaranteeTypeCode**\n\n- T (Garantido pelo Tesouro)\n- G (Garantido por Terceiros - Fian\u00e7a)\n- S (Garantia Real)\n- UF (Flutuante)\n- US (Subordinada)\n- UQ (Quirograf\u00e1ria)\n\n**indexerCode**\n\n- ANB (Taxa ANBID)<br>\n- DI F (Contrato Futuro de Taxa DI)\n- DI1 (Taxa CDI Cetip)\n- DOF (Cupom de d\u00f3lar flutuante)\n- DOL (Cupom de d\u00f3lar comercial)\n- DOLP (Cupom de d\u00f3lar \u2014 Ptx800)\n- IGP (\u00cdndice Geral de Pre\u00e7os \u2014 Mercado)\n- IGPD (\u00cdndice Geral de Pre\u00e7os \u2014 DI)\n- INCC (\u00cdndice Nacional de Custo Da Constru\u00e7\u00e3o)\n- INPC (Taxa INPC)\n- IP (\u00cdndice de Poupan\u00e7a)\n- IPC (\u00cdndice de Pre\u00e7os ao Consumidor \u2014 Fipe)\n- IPCA (\u00cdndice Nacional de Pre\u00e7os ao Consumidor Amplo \u2014 IBGE)\n- JPY (Iene)\n- PRE (Taxa Pr\u00e9-Fixada)\n- SEL (Taxa Selic)\n- TBF (Taxa B\u00e1sica de Juros)\n- TJ3 (Taxa de Juros de Refer\u00eancia \u2014 3 Meses)\n- TJL (Taxa TJLP)\n- TMS (Taxa TMS)\n- TR (Taxa Referencial)\n\n**periodicityCode**\n\n- ANB (Taxa ANBID)\n- DI F (Contrato Futuro de Taxa DI)\n- DI1 (Taxa CDI Cetip)\n- DOF (Cupom de d\u00f3lar flutuante)\n- DOL (Cupom de d\u00f3lar comercial)\n- DOLP (Cupom de d\u00f3lar \u2014 Ptx800)\n- IGP (\u00cdndice Geral de Pre\u00e7os \u2014 Mercado)\n- IGPD (\u00cdndice Geral de Pre\u00e7os \u2014 DI)\n- INCC (\u00cdndice Nacional de Custo Da Constru\u00e7\u00e3o)\n- INPC (Taxa INPC)\n- IP (\u00cdndice de Poupan\u00e7a)\n- IPC (\u00cdndice de Pre\u00e7os ao Consumidor \u2014 Fipe)\n- IPCA (\u00cdndice Nacional de Pre\u00e7os ao Consumidor Amplo \u2014 IBGE)\n- JPY (Iene)\n- PRE (Taxa Pr\u00e9-Fixada)\n- SEL (Taxa Selic)\n- TBF (Taxa B\u00e1sica de Juros)\n- TJ3 (Taxa de Juros de Refer\u00eancia \u2014 3 Meses)\n- TJL (Taxa TJLP)\n- TMS (Taxa TMS)\n- TR (Taxa Referencial)\n\n**marketTypeCode**\n\n- S (Padronizado)\n- N (N\u00e3o Padronizado)\n\n**protectionTypeCode**                                                                                                                                                                                                                                   |\n\n- S (Protegida)\n- N (N\u00e3o Protegida)\n\n**securitySubTypeCode**\n\n- S (A\u00e7\u00f5es. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- N (Taxa de Juros. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- T (Commodities. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- C (Moedas. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- I (\u00cdndices. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- O (Op\u00e7\u00f5es. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- F (Futuros. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- W (Swap. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- B (Cesta. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- D (Renda Fixa. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- M (Outros. V\u00e1lido para as categorias op\u00e7\u00f5es, futuro, estrat\u00e9gia)\n- B (Renda Fixa. V\u00e1lido para a categoria outros)\n- H (A\u00e7\u00f5es e Renda Fixa. V\u00e1lido para a categoria outros)\n- A (A\u00e7\u00f5es e B\u00f4nus. V\u00e1lido para a categoria outros)\n\n**categoryCode**\n\n- K (Estrat\u00e9gia)\n- J (Termo)\n- L (Financiamento)\n- C (Ve\u00edculos de Investimento Coletivo)\n- D (Renda Fixa)\n- E (Renda Vari\u00e1vel)\n- F (Futuro)\n- M (Outros)\n- O (Op\u00e7\u00f5es)\n- R (Direitos)\n- S (Swap)\n- H (Op\u00e7\u00f5es de Balc\u00e3o)\n- T (Instrumento Referencial)\n\n**statusCode**\n\n- N (Novo)\n- A (Atualizado)\n- D (Inativado)\n- R (Reutilizado)\n\n**specieCode**\n\n- M1 (Miscel\u00e2nea)\n- OR (Ordin\u00e1rias)\n- PA (Preferenciais Classe A)\n- PB (Preferenciais Classe B)\n- PC (Preferenciais Classe C)\n- PD (Preferenciais Classe D)\n- PE (Preferenciais Classe E)\n- PF (Preferenciais Classe F)\n- PG (Preferenciais Classe G)\n- PH (Preferenciais Classe H)\n- PR (Preferenciais)\n- V1 (Preferenciais com Direito a Voto)\n- ZZ (Esp\u00e9cie Autom\u00e1tica)\n- PI (Preferenciais Classe I)\n- PJ (Preferenciais Classe J)\n- PK (Preferenciais Classe K)\n- XX (Miscel\u00e2nea)\n- X2 (Miscel\u00e2nea)                                                                                                                                                                                                                                                                                                                                                                                                                     |\n\n<\/details><br\/>\n\n<details><summary><b>Host<\/b><\/summary><br\/><p>\n\n**Acesso pela Internet:**\n\n- Certifica\u00e7\u00e3o: https:\/\/api-listados-cert.b3.com.br\/\n\n- Produ\u00e7\u00e3o: https:\/\/api-listados.b3.com.br\/\n\n<\/p><\/details><br\/>\n\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\n\n[Clique aqui](\/index.php?option=com_content&view=article&id=27) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado.\n\t\n<\/p><\/details><br\/>\n","deprecated":false,"apiVersion":"1.0.0-rc3","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/isins\/v1","models":{"IsinBatchesReqPatch":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/UpdateIsinDto"}}},"id":"IsinBatchesReqPatch"},"Meta":{"type":"object","required":["totalPages","totalRecords"],"properties":{"totalRecords":{"type":"integer","format":"int32","example":100,"description":"Total number of records.","minimum":-2147483648,"maximum":2147483647},"totalPages":{"type":"integer","format":"int32","example":100,"description":"Total number of pages. ","minimum":-2147483648,"maximum":2147483647}}},"IsinCodeRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/QueryIsinDto"},"links":{"$ref":"#\/definitions\/Link"}}},"RegistrationIsinDto":{"type":"object","required":["assetCode"],"properties":{"assetCode":{"type":"string","example":"CDB","description":"Asset code. Valid for the categories options, futures, strategy, term, others, fixed income","maxLength":10},"cetipCode":{"type":"string","example":"SNA-CABN M4601","description":"Valid only for the category fixed income. Can be null","minLength":1,"maxLength":20},"deliveryTypeCode":{"type":"string","example":"P","description":"Delivery type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * P - F\u00edsica * C - Financeira","maxLength":1,"enum":["P","C"]},"dueDate":{"type":"string","format":"date","example":"2025-01-01","description":"Due date of the ISIN (ISO 8601 date in the format YYYY-MM-DD). Valid for the categories options, futures, strategy, term, others, fixed income, swap"},"dueDateTypeCode":{"type":"string","example":"F","description":"Due date type of the ISIN. Valid only for the category fixed income. This value should be informed. Possible values: * P - Perp\u00e9tuo * F - Vencimento Fixo * G - Resgate Antecipado * A - Plano de Amortiza\u00e7\u00e3o * B - Plano de Amortiza\u00e7\u00e3o com Resgate Antecipado * Q - Perp\u00e9tuo com Op\u00e7\u00e3o de Resgate","maxLength":1,"enum":["P","F","G","A","B","Q"]},"emissionDate":{"type":"string","format":"date","example":"2025-01-01","description":"ISIN emission date (ISO 8601 date in the format YYYY-MM-DD). Valid for the categories options, futures, strategy, term, others, fixed income, swap"},"emissionTypeCode":{"type":"string","example":"D","description":"Emission type of the ISIN. Valid only for the category fixed income. Possible values: * D - Emiss\u00e3o Dom\u00e9stica * I - Emiss\u00e3o Internacional","maxLength":1,"enum":["D","I"]},"exercisePriceValue":{"type":"number","format":"double","example":1000,"description":"Exercise price of the ISIN. Valid for the categories options, futures, strategy. Should be a number with precision of at most 18 and scale of 2"},"exerciseTypeCode":{"type":"string","example":"A","description":"Exercise type of the option. Valid for the categories options, futures, strategy. Possible values: * A - Americana * E - Europ\u00e9ia","maxLength":1,"enum":["A","E"]},"guaranteeTypeCode":{"type":"string","example":"T","description":"Guarantee type of the ISIN. Valid only for the category fixed income. Possible values: * T - Garantido pelo Tesouro * G - Garantido por Terceiros (Fian\u00e7a) * S - Garantia Real * UF - Flutuante * US - Subordinada * UQ - Quirograf\u00e1ria","minLength":1,"maxLength":2,"enum":["T","G","S","UF","US","UQ"]},"indexPercentage":{"type":"number","format":"double","example":9.99,"description":"Index Percentage. Valid only for the category fixed income"},"indexerCode":{"type":"string","example":"DOF","description":"Market indexer code of the ISIN. Valid only for the category fixed income.","minLength":1,"maxLength":4},"interestRate":{"$ref":"#\/definitions\/AssetInterestRateDto"},"isinEmissionCode":{"type":"string","example":"19","description":"ISIN emission Code. Valid only for the category fixed income. Can be null","maxLength":4},"issuerCode":{"type":"string","example":"B3SA","description":"Issuer code. Valid for the categories options, futures, strategy, fixed income","minLength":1,"maxLength":4},"marketTypeCode":{"type":"string","example":"S","description":"Market type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * S - Padronizado * N - N\u00e3o Padronizado","maxLength":1,"enum":["S","N"]},"nominalValue":{"type":"number","format":"double","example":1000,"description":"Nominal value of the ISIN. Valid for the categories options, futures, strategy, term, others, fixed income, swap. Should be a number with precision of at most 16 and scale of 2"},"optionSeriesCode":{"type":"string","example":"1350","description":"Option series code. Valid for the categories options, futures, strategy. Identifies the specific series that the option belongs to.","minLength":1,"maxLength":6},"protectionTypeCode":{"type":"string","example":"S","description":"Protection type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * S - Protegida * N - N\u00e3o Protegida","maxLength":1,"enum":["S","N"]},"securitySubTypeCode":{"type":"string","example":"S","description":"Security sub-type of the ISIN. Valid for the categories options, futures, strategy, others. Possible values: * S - A\u00e7\u00f5es (valid for the categories options, future, strategy) * N - Taxa de Juros (valid for the categories options, future, strategy) * T - Commodities (valid for the categories options, future, strategy) * C - Moedas (valid for the categories options, future, strategy) * I - \u00cdndices (valid for the categories options, future, strategy) * O - Op\u00e7\u00f5es (valid for the categories options, future, strategy) * F - Futuros (valid for the categories options, future, strategy) * W - Swap (valid for the categories options, future, strategy) * B - Cesta (valid for the categories options, future, strategy) * D - Renda Fixa (valid for the categories options, future, strategy) * M - Outros (valid for the categories options, future, strategy) * B - Renda Fixa (valid for the category others) * H - A\u00e7\u00f5es e Renda Fixa (valid for the category others) * A - A\u00e7\u00f5es e B\u00f4nus (valid for the category others)","maxLength":1,"enum":["S","N","T","C","I","O","F","W","D","M","B","H","A"]},"selicCode":{"type":"string","example":"950199","description":"SELIC code. Valid only for the category fixed income. Can be null","minLength":1,"maxLength":6,"pattern":"^[a-zA-Z0-9]{1,6}$"},"seriesCode":{"type":"string","example":"7","description":"Series code. Valid only for the category fixed income. Can be null","minLength":1,"maxLength":4,"pattern":"^[a-zA-Z0-9]{1,4}$"}},"description":"Represents the ISIN data transferred through the API"},"IsinCodeReqPatch":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/UpdateIsinDto"}},"id":"IsinCodeReqPatch"},"IsinBatchesRspPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/OperationResultPatchBatchesPost"}}},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","example":"juksivjiw","description":"Business error code. ","maxLength":10},"title":{"type":"string","example":"whjpoeafhqpqsdkuatbyknjjpduazuvopwbjcdjrultoydmowm","description":"Brief error message. ","maxLength":100},"detail":{"type":"string","example":"vvqnqfhdvjzszkvrmrlnguuwkwyklzqxsibfbkdcbpglqkvjhl","description":"Complementary information regarding error. ","maxLength":2000}}},"OperationResultDto":{"type":"object","properties":{"isinCode":{"type":"string","example":"BRB3SAACNOR6","description":"Isin Code.","minLength":12,"maxLength":12}}},"OperationResultPatchBatchesPost":{"type":"object","properties":{"createdIsins":{"type":"array","items":{"$ref":"#\/definitions\/OperationResultDto"}},"failedIsins":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}},"AssetInterestRateDto":{"type":"object","properties":{"firstPaymentDate":{"type":"string","format":"date","example":"2025-05-01","description":"First payment date of the ISIN (ISO 8601 date in the format YYYY-MM-DD). Required and valid only for the category fixed income."},"percentageValue":{"type":"number","format":"double","example":12.5,"description":"Percentage value of the ISIN. Required and valid only for the category fixed income. Should be a number with precision of at most 8 and scale of 4"},"periodicityCode":{"type":"string","example":"M","description":"Periodicity code for interest payments. Required and valid only for the category fixed income. Possible values: * B - Bi-anual * A - Anual * S - Semestral * Q - Trimestral * M - Mensal * W - Semanal * D - Di\u00e1rio * N - N\u00e3o aplic\u00e1vel * X - Outros","maxLength":1,"enum":["B","A","S","Q","M","W","D","N","X"]}},"description":"Interest rate. Valid only for the category fixed income"},"IsinReqPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/RegistrationIsinDto"}},"id":"IsinReqPost"},"QueryIsinDto":{"type":"object","properties":{"categoryCode":{"type":"string","example":"D","description":"ISIN category code. Possible values: K - STRATEGIES (ESTRAT\u00c9GIA), J - FORWARDS (TERMO), L - FINANCING (FINANCIAMENTO), C - COLLECTIVE INVESTMENTS VEHICLES (VE\u00cdCULOS DE INVESTIMENTO COLETIVO), D - DEBT INSTRUMENTS (RENDA FIXA), E - EQUITIES (RENDA VARI\u00c1VEL), F - FUTURES (FUTURO), M - OTHERS MISCELLANEOUS (OUTROS), O - OPTIONS (OP\u00c7\u00d5ES), R - ENTITLEMENTS RIGHTS (DIREITOS), S - SWAP, H - COUNTER OPTIONS (OP\u00c7\u00d5ES DE BALC\u00c3O), T - REFERENCE INSTRUMENT (INSTRUMENTO REFERENCIAL)","maxLength":1,"enum":["K","J","L","C","D","E","F","M","O","R","S","H","T"]},"cfiCode":{"type":"string","example":"ESVUFR","description":"CFI code (defined by ISO 10962) that classifies the financial instrument","minLength":6,"maxLength":6},"dueDate":{"type":"string","format":"date","example":"2025-01-01","description":"Due date of the ISIN (ISO 8601 date in the format YYYY-MM-DD)"},"emissionDate":{"type":"string","format":"date","example":"2025-01-01","description":"ISIN emission date (ISO 8601 date in the format YYYY-MM-DD)"},"exercisePriceValue":{"type":"number","format":"double","example":1000,"description":"Exercise price of the ISIN. Valid for the categories options, futures, strategy. Should be a number with precision of at most 18 and scale of 2"},"fisnCode":{"type":"string","example":"B32DA\/RegSh Vtg FPd NPV","description":"FISN code","minLength":1,"maxLength":35},"isinCode":{"type":"string","example":"BRB3SAACNOR6","description":"ISIN code. ISIN code (defineid by ISO 6166) that uniquely identifies the security","minLength":12,"maxLength":12},"isinRequesterName":{"type":"string","example":"B3","description":"ISIN issuance requester","minLength":1,"maxLength":150},"issuerCode":{"type":"string","example":"B3SA","description":"Issuer code. Valid for the categories options, futures, strategy, fixed income","minLength":1,"maxLength":4},"nominalValue":{"type":"number","format":"double","example":1000,"description":"Nominal value of the ISIN"},"specieCode":{"type":"string","example":"ZZ","description":"ISIN specie. Possible values: M1,OR,PA,PB,PC,PD,PE,PF,PG,PH,PI,PJ,PK,PR,V1,XX,ZZ","maxLength":2,"enum":["OR","PR","PA","PB","PC","PD","PE","PF","PG","PH","PI","PJ","PK","V1","M1","XX","ZZ"]},"statusCode":{"type":"string","example":"N","description":"ISIN status. Possible values: N - NEW (NOVO), A - UPDATED (ATUALIZADO), D - INACTIVATED (INATIVADO), R - REUSED (REUTILIZADO)","maxLength":1,"enum":["N","A","D","R"]}}},"IsinCodeRspPatch":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/OperationResultDto"}}},"IsinRspPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/OperationResultDto"}}},"IsinBatchesRspPatch":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/OperationResultPatchBatchesPost"}}},"IsinRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/QueryIsinDto"}},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"UpdateIsinDto":{"type":"object","required":["isinCode"],"properties":{"cetipCode":{"type":"string","example":"SNA-CABN M4601","description":"Valid only for the category fixed income. Can be null","minLength":1,"maxLength":20},"deliveryTypeCode":{"type":"string","example":"P","description":"Delivery type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * P - F\u00edsica * C - Financeira","maxLength":1,"enum":["P","C"]},"dueDate":{"type":"string","format":"date","example":"2025-01-01","description":"Due date of the ISIN (ISO 8601 date in the format YYYY-MM-DD). Valid for the categories options, futures, strategy, others, fixed income, swap"},"dueDateTypeCode":{"type":"string","example":"F","description":"Due date type of the ISIN. Valid only for the category fixed income. This value should be informed. Possible values: * P - Perp\u00e9tuo * F - Vencimento Fixo * G - Resgate Antecipado * A - Plano de Amortiza\u00e7\u00e3o * B - Plano de Amortiza\u00e7\u00e3o com Resgate Antecipado * Q - Perp\u00e9tuo com Op\u00e7\u00e3o de Resgate","maxLength":1,"enum":["P","F","G","A","B","Q"]},"emissionDate":{"type":"string","format":"date","example":"2025-01-01","description":"ISIN emission date (ISO 8601 date in the format YYYY-MM-DD). Valid for the categories options, futures, strategy, others, fixed income, swap"},"emissionTypeCode":{"type":"string","example":"D","description":"Emission type of the ISIN. Valid only for the category fixed income. Possible values: * D - Emiss\u00e3o Dom\u00e9stica * I - Emiss\u00e3o Internacional","maxLength":1,"enum":["D","I"]},"exercisePriceValue":{"type":"number","format":"double","example":1000,"description":"Exercise price of the ISIN. Valid for the categories options, futures, strategy. Should be a number with precision of at most 18 and scale of 2"},"exerciseTypeCode":{"type":"string","example":"A","description":"Exercise type of the option. Valid for the categories options, futures, strategy. Possible values: * A - Americana * E - Europ\u00e9ia","maxLength":1,"enum":["A","E"]},"guaranteeTypeCode":{"type":"string","example":"T","description":"Guarantee type of the ISIN. Valid only for the category fixed income. Possible values: * T - Garantido pelo Tesouro * G - Garantido por Terceiros (Fian\u00e7a) * S - Garantia Real * UF - Flutuante * US - Subordinada * UQ - Quirograf\u00e1ria","minLength":1,"maxLength":2,"enum":["T","G","S","UF","US","UQ"]},"indexPercentage":{"type":"number","format":"double","example":9.99,"description":"Index Percentage. Valid only for the category fixed income"},"indexerCode":{"type":"string","example":"DOF","description":"Market indexer code of the ISIN. Valid only for the category fixed income.","minLength":1,"maxLength":4},"interestRate":{"$ref":"#\/definitions\/AssetInterestRateDto"},"isinCode":{"type":"string","example":"BRB3SAACNOR6","description":"ISIN code. ISIN code (defineid by ISO 6166) that uniquely identifies the security. Valid for the categories options, futures, strategy, term, others, fixed income, swap","minLength":12,"maxLength":12},"isinEmissionCode":{"type":"string","example":"19","description":"ISIN emission Code. Valid only for the category fixed income. Can be null","maxLength":4},"issuerCode":{"type":"string","example":"B3SA","description":"Issuer code. Valid for the categories options, futures, strategy, fixed income","minLength":1,"maxLength":4},"marketTypeCode":{"type":"string","example":"S","description":"Market type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * S - Padronizado * N - N\u00e3o Padronizado","maxLength":1,"enum":["S","N"]},"nominalValue":{"type":"number","format":"double","example":1000,"description":"Nominal value of the ISIN. Valid for the categories options, futures, strategy, term, others, fixed income, swap. Should be a number with precision of at most 16 and scale of 2"},"optionSeriesCode":{"type":"string","example":"1350","description":"Option series code. Valid for the categories options, futures, strategy. Identifies the specific series that the option belongs to.","minLength":1,"maxLength":6},"protectionTypeCode":{"type":"string","example":"S","description":"Protection type of the ISIN. Valid for the categories options, futures, strategy. Possible values: * S - Protegida * N - N\u00e3o Protegida","maxLength":1,"enum":["S","N"]},"securitySubTypeCode":{"type":"string","example":"S","description":"Security sub-type of the ISIN. Valid for the categories options, futures, strategy, others. Possible values: * S - A\u00e7\u00f5es (valid for the categories options, future, strategy) * N - Taxa de Juros (valid for the categories options, future, strategy) * T - Commodities (valid for the categories options, future, strategy) * C - Moedas (valid for the categories options, future, strategy) * I - \u00cdndices (valid for the categories options, future, strategy) * O - Op\u00e7\u00f5es (valid for the categories options, future, strategy) * F - Futuros (valid for the categories options, future, strategy) * W - Swap (valid for the categories options, future, strategy) * B - Cesta (valid for the categories options, future, strategy) * D - Renda Fixa (valid for the categories options, future, strategy) * M - Outros (valid for the categories options, future, strategy) * B - Renda Fixa (valid for the category others) * H - A\u00e7\u00f5es e Renda Fixa (valid for the category others) * A - A\u00e7\u00f5es e B\u00f4nus (valid for the category others)","maxLength":1,"enum":["S","N","T","C","I","O","F","W","B","D","M","H","A"]},"selicCode":{"type":"string","example":"950199","description":"SELIC code. Valid only for the category fixed income. Can be null","minLength":1,"maxLength":6,"pattern":"^[a-zA-Z0-9]{1,6}$"},"seriesCode":{"type":"string","example":"7","description":"Series code. Valid only for the category fixed income. Can be null","minLength":1,"maxLength":4,"pattern":"^[a-zA-Z0-9]{1,4}$"}},"description":"Represents the ISIN data transferred through the API"},"errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}},"Link":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"http:\/\/localhost:8080\/api\/v1\/isins?page=0&size=10","description":"Link to current page. ","maxLength":2000},"first":{"type":"string","example":"http:\/\/localhost:8080\/api\/v1\/isins?page=0&size=10","description":"Link to first page.","maxLength":2000},"prev":{"type":"string","example":"http:\/\/localhost:8080\/api\/v1\/isins?page=0&size=10","description":"Link to previous page.","maxLength":2000},"next":{"type":"string","example":"http:\/\/localhost:8080\/api\/v1\/isins?page=0&size=10","description":"Link to next page.","maxLength":2000},"last":{"type":"string","example":"http:\/\/localhost:8080\/api\/v1\/isins?page=0&size=10","description":"Link to last page.","maxLength":2000}}},"IsinBatchesReqPost":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/RegistrationIsinDto"}}},"id":"IsinBatchesReqPost"}},"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":"ISIN API","summary":"API for ISIN management","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":["LISTADOS"]},"availableApiDefinitions":{"Swagger 1.1":"\/discovery\/swagger\/api\/id\/78646d15-2690-42df-9822-93e2860fe708?swaggerVersion=1.1&filename=ISIN%2BAPI.json","Swagger 2.0":"\/discovery\/swagger\/api\/id\/78646d15-2690-42df-9822-93e2860fe708?swaggerVersion=2.0&filename=ISIN%2BAPI.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/78646d15-2690-42df-9822-93e2860fe708\/ios-swift","android":"\/discovery\/sdk\/78646d15-2690-42df-9822-93e2860fe708\/android","nodejs":"\/discovery\/sdk\/78646d15-2690-42df-9822-93e2860fe708\/nodejs"},"apis":[{"path":"\/api\/isins\/v1\/isin\/{isinCode}","name":"\/isin\/{isinCode}","operations":[{"id":"78051222-b468-4531-a416-f6365827c86f","description":"","httpMethod":"DELETE","nickname":"IsinCodeReqDelete","summary":"Delete a ISIN by its code","responseClass":"void","errorResponses":[{"code":204,"reason":"No Content"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":[],"tags":{},"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"}]},"cors":true,"parameters":[{"description":"ISIN code","required":true,"maxLength":12,"minLength":12,"name":"isinCode","dataType":"string","paramType":"path","allowMultiple":false}]},{"id":"42885156-e88b-43ab-9e03-7abd09135bcd","description":"","httpMethod":"PATCH","nickname":"IsinCodeReqPatch","summary":"Update a ISIN","responseClass":"IsinCodeRspPatch","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":["application\/json"],"produces":["application\/json"],"tags":{},"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"}]},"cors":true,"parameters":[{"description":"ISIN code","required":true,"maxLength":12,"minLength":12,"name":"isinCode","dataType":"string","paramType":"path","allowMultiple":false},{"description":"","required":true,"name":"IsinCodeReqPatch","dataType":"IsinCodeReqPatch","paramType":"body","allowMultiple":false}]},{"id":"2e3ca398-2400-4bf4-9860-a10346639cca","description":"","httpMethod":"GET","nickname":"IsinCodeReqGet","summary":"Find ISIN data by ISIN code. Returns detailed information about an ISIN based on its code","responseClass":"IsinCodeRspGet","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":"ISIN code","required":true,"maxLength":12,"minLength":12,"name":"isinCode","dataType":"string","paramType":"path","allowMultiple":false}]}]},{"path":"\/api\/isins\/v1\/isin\/batches","name":"\/isin\/batches","operations":[{"id":"ed28ad34-0209-4fec-aa0e-49b8c96df07f","description":"","httpMethod":"POST","nickname":"IsinBatchesReqPost","summary":"Create Isin Batch","responseClass":"IsinBatchesRspPost","errorResponses":[{"code":201,"reason":"Created"},{"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":["application\/json"],"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":"","required":true,"name":"IsinBatchesReqPost","dataType":"IsinBatchesReqPost","paramType":"body","allowMultiple":false}]},{"id":"f7d54666-8d06-46ae-b118-5d09f73df8e5","description":"","httpMethod":"PATCH","nickname":"IsinBatchesReqPatch","summary":"Update ISINs","responseClass":"IsinBatchesRspPatch","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":["application\/json"],"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":"","required":true,"name":"IsinBatchesReqPatch","dataType":"IsinBatchesReqPatch","paramType":"body","allowMultiple":false}]}]},{"path":"\/api\/isins\/v1\/isin","name":"\/isin","operations":[{"id":"c37b2d3f-a109-4a14-9ddf-3acdae888e45","description":"","httpMethod":"GET","nickname":"IsinReqGet","summary":"Find ISINs.Returns detailed information about the ISINs","responseClass":"IsinRspGet","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":"Category code. Allowed values: K - STRATEGIES (ESTRAT\u00c9GIA), J - FORWARDS (TERMO), L - FINANCING (FINANCIAMENTO), C - COLLECTIVE INVESTMENTS VEHICLES (VE\u00cdCULOS DE INVESTIMENTO COLETIVO), D - DEBT INSTRUMENTS (RENDA FIXA), E - EQUITIES (RENDA VARI\u00c1VEL), F - FUTURES (FUTURO), M - OTHERS MISCELLANEOUS (OUTROS), O - OPTIONS (OP\u00c7\u00d5ES), R - ENTITLEMENTS RIGHTS (DIREITOS), S - SWAP, H - COUNTER OPTIONS (OP\u00c7\u00d5ES DE BALC\u00c3O), T - REFERENCE INSTRUMENT (INSTRUMENTO REFERENCIAL)","required":false,"maxLength":1,"name":"categoryCode","dataType":"string","paramType":"query","allowMultiple":false,"enum":["K","J","L","C","D","E","F","M","O","R","S","H","T"]},{"description":"Due date (ISO 8601 date in the format YYYY-MM-DD)","format":"date","required":false,"name":"dueDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Emission date (ISO 8601 date in the format YYYY-MM-DD)","format":"date","required":false,"name":"emissionDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"End date for the search (ISO 8601 date in the format YYYY-MM-DD). This parameter is based in the ISIN emission date","format":"date","required":false,"name":"endDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Acronym of the ISIN","required":false,"maxLength":10,"minLength":2,"name":"isinAcronym","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Number of the page being requested (the value for the first page is 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"Total number of records per page.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false},{"description":"Start date for the search (ISO 8601 date in the format YYYY-MM-DD). This parameter is based in the ISIN emission date","format":"date","required":false,"name":"startDate","dataType":"string","paramType":"query","allowMultiple":false},{"description":"ISIN status. Allowed values: A - Active, I - Inactive","required":false,"maxLength":1,"name":"statusCode","dataType":"string","paramType":"query","allowMultiple":false,"enum":["A","I"]}]},{"id":"682e4f1f-a717-424a-9d3f-929aacccf8d3","description":"","httpMethod":"POST","nickname":"IsinReqPost","summary":"Create a new ISIN","responseClass":"IsinRspPost","errorResponses":[{"code":201,"reason":"Created"},{"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":["application\/json"],"produces":["application\/json"],"tags":{},"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"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"IsinReqPost","dataType":"IsinReqPost","paramType":"body","allowMultiple":false}]}]}],"createDate":1756500252422,"accessGrantedDate":1756500253849,"type":"rest","enableInlineTryIt":true}