Pular para o conteúdo principal

Transações - Exemplos

Regular​

A maioria das suas transações provavelmente será desse tipo. Nós as dividimos nas seguintes categorias:

Regular - Ativos com Preço e Quantidade​

Essas operações incluem os seguintes tipos de títulos: Títulos Bancários, BDRs, COE, Commodities, Crédito Privado (CRA, CRI, CDCA e Debêntures), Criptomoedas, ETFs, FIIs, Fundos, Futuros, Ativos Personalizados, Títulos do Governo, Opções de Índice, Termos de Ações, Índices de Ações, Opções de Ações, Recibos de Subscrição de Ações, Direitos de Subscrição de Ações e Ações.

Uma vez que esses são títulos brasileiros "convencionais", você só precisará do preço e da quantidade da transação. Consideraremos a moeda como BRL; portanto, inserir uma taxa de câmbio (exchangeRate) resultará em um erro.

Vale ressaltar que os Títulos Bancários (CDBs, LCs, LCAs, LCIs, LFs e afins), os Termos de Ações e os Ativos Personalizados são títulos gerenciados pela Organização (Organization), o que significa que você precisa criá-los antes de realizar uma transação com eles.

Exemplos:

Para inserir transações, faça requisições para Criar Transação (Create Transaction).

Observações:

  • Para procurar brokerId, consulte: Listar Corretoras (List Brokers).

  • Para procurar securityId e ISIN, consulte: Listar Ativos (List Securities).

Títulos Bancários (CDB, LC, LCA, LCI, LF e afins)​

Tipo de identificador aceito para o ativo: securityId.

Todos os ativos deste grupo (incluindo DPGE, LCD, LFS, LFSN, LIG, RDB, RDC, P2B Lending e Compromissadas) precisam ser criados antes, o que significa que você só precisa especificar as características do título desejado. Em todos os casos, uma vez criado, você receberá um novo securityId do título especificado ou derivado, e esse securityId é o relevante para criar uma transação.

Crie uma transação de LCA: 5.00% a.a. usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2020-01-02",
"quantity": 50,
"brokerId": "27652684000162",
"security": {
"id": 63621557
},
"side": "BUY",
"price": 1000
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "b783dfab-1ea1-40dd-a59d-f7e95d3dfd3b",
"quantity": 50,
"transactDate": "2020-01-02",
"status": "PROCESSING",
"price": 1000,
"side": "BUY",
"security": {
"id": 63621557,
"name": "LCA : 5.00% a.a. (emissor: BANCO TOYOTA DO BRASIL)",
"type": "CORPORATE_BONDS_LCA",
"issuer": "03.215.790/0001-10"
},
"broker": {
"kind": "broker",
"id": "27652684000162",
"name": "GENIAL INVESTIMENTOS",
"taxId": "27.652.684/0001-62",
"country": {
"name": "Brazil",
"symbol": "BR"
}
},
"fees": {},
"createdDate": "2023-07-17T17:37:12.669586Z",
"updatedDate": "2023-07-17T17:37:12.669586Z"
}

BDRs​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de XPBR31 usando o identificador ISIN:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-06",
"quantity": 300,
"brokerId": "18945670000146",
"security": {
"isin": "BRXPBRBDR001"
},
"side": "BUY",
"price": 60.00,
"fees": {
"brokerageFee": 1.00,
"exchangeFee": 0.20
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "d110a188-cca6-4ed1-935a-cc92b929b32b",
"quantity": 300,
"transactDate": "2023-03-06",
"status": "PROCESSING",
"price": 60,
"side": "BUY",
"security": {
"id": 57921351,
"isin": "BRXPBRBDR001",
"name": "XPBR31",
"type": "STOCK_BDR",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1,
"exchangeFee": 0.2
},
"createdDate": "2023-04-11T14:02:05.483273Z",
"updatedDate": "2023-04-11T14:02:05.483273Z"
}

COE​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de Banco XP S.A Jan/2028 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-28",
"quantity": 100,
"brokerId": "02332886001178",
"security": {
"id": 62860971
},
"side": "BUY",
"price": 4.97,
"fees": {
"brokerageFee": 1.20,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "5fc86485-1924-4cd7-92ed-2d313300b1e3",
"quantity": 100,
"transactDate": "2023-03-28",
"status": "PROCESSING",
"price": 4.97,
"side": "BUY",
"security": {
"id": 62860971,
"name": "COE Banco XP S.A Jan/2028",
"type": "STRUCTURED_COE"
},
"broker": {
"id": "02332886001178",
"name": "XP INVESTIMENTOS CCTVM"
},
"fees": {
"brokerageFee": 1.2,
"exchangeFee": 0.5
},
"createdDate": "2023-04-11T14:17:25.229141Z",
"updatedDate": "2023-04-11T14:17:25.229141Z"
}

Commodities​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de OZ1D usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 10,
"price": 20,
"brokerId": "18945670000146",
"security": {
"id": 4998484
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "c1ebe1f1-d0da-4586-b450-065ebf15950b",
"quantity": 10,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 20,
"side": "BUY",
"security": {
"id": 4998484,
"isin": "BRBMEFOZ1003",
"name": "OZ1D",
"type": "CURRENCY_COMMODITY",
"assetClass": "CURRENCIES"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T23:35:46.602846Z",
"updatedDate": "2023-05-08T23:35:46.602846Z"
}

Corporate Bonds (CRA, CRI, CDCA, Debêntures)​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de CORPORATE_BONDS_DEBENTURE usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-07-13",
"quantity": 10,
"brokerId": "27652684000162",
"security": {
"id": 74580
},
"side": "BUY",
"price": 1082.46,
"fees": {
"brokerageFee": 4.78,
"exchangeFee": 9.54
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "d71843d9-3a74-4654-ad98-30520aa0dc5e",
"quantity": 10,
"transactDate": "2023-07-13",
"status": "PROCESSING",
"price": 1082.46,
"side": "BUY",
"security": {
"id": 74580,
"isin": "BRPETRDBS0C2",
"name": "PETR27",
"type": "CORPORATE_BONDS_DEBENTURE"
},
"broker": {
"kind": "broker",
"id": "27652684000162",
"name": "GENIAL INVESTIMENTOS",
"taxId": "27.652.684/0001-62",
"country": {
"name": "Brazil",
"symbol": "BR"
}
},
"fees": {
"brokerageFee": 4.78,
"exchangeFee": 9.54
},
"createdDate": "2023-07-17T17:23:58.9258Z",
"updatedDate": "2023-07-17T17:23:58.9258Z"
}

Cryptocurrencies​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de BTC usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-29",
"quantity": 0.5,
"brokerId": "18945670000146",
"security": {
"id": 128320
},
"side": "BUY",
"price": 76357.50,
"fees": {
"brokerageFee": 0.10,
"exchangeFee": 0.20
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "8948b17f-272d-4279-b09c-fd4a7272586d",
"quantity": 0.5,
"transactDate": "2023-03-29",
"status": "PROCESSING",
"price": 76357.50,
"side": "BUY",
"security": {
"id": 128320,
"name": "BTC",
"type": "CRYPTOCURRENCY",
"assetClass": "CURRENCIES"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 0.1,
"exchangeFee": 0.2
},
"createdDate": "2023-04-11T17:27:38.162076Z",
"updatedDate": "2023-04-11T17:27:38.162076Z"
}

ETFs​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de BOVA11 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-09",
"quantity": 100,
"brokerId": "18945670000146",
"security": {
"isin": "BRBOVACTF003"
},
"side": "BUY",
"price": 98.66,
"fees": {
"brokerageFee": 0.90,
"exchangeFee": 0.20
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "69e11bf6-11d0-4338-bb74-343c0d254344",
"quantity": 100,
"transactDate": "2023-03-09",
"status": "PROCESSING",
"price": 98.66,
"side": "BUY",
"security": {
"id": 124689,
"isin": "BRBOVACTF003",
"name": "BOVA11",
"type": "STOCK_ETF",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 0.9,
"exchangeFee": 0.2
},
"createdDate": "2023-04-11T14:09:25.978651Z",
"updatedDate": "2023-04-11T14:09:25.978651Z"
}

FIIs​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de MXRF11 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-07",
"quantity": 500,
"brokerId": "18945670000146",
"security": {
"isin": "BRMXRFCTF008"
},
"side": "BUY",
"price": 9.50,
"fees": {
"brokerageFee": 1.00,
"exchangeFee": 0.40
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "776287ce-4b50-4b7e-8e5b-23711578d4df",
"quantity": 500,
"transactDate": "2023-03-07",
"status": "PROCESSING",
"price": 9.5,
"side": "BUY",
"security": {
"id": 123009,
"isin": "BRMXRFCTF008",
"name": "MXRF11",
"type": "FII",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1,
"exchangeFee": 0.4
},
"createdDate": "2023-04-11T13:52:40.17797Z",
"updatedDate": "2023-04-11T13:52:40.17797Z"
}

Funds​

Tipos de identificadores aceitos para o ativo: securityId ou CNPJ.

Criando uma transação de GIANT ZARATHUSTRA FC FIM usando CNPJ:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"price": 40,
"quantity": 50,
"brokerId": "18945670000146",
"security": {
"cnpj": "11052478000181"
},
"side": "BUY",
"fees": {
"brokerageFee": 1.20,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "ed9dbfd3-bc2c-4223-aa4d-b26d7b08bc4b",
"quantity": 50,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 40,
"side": "BUY",
"security": {
"id": 2407939,
"cnpj": "11052478000181",
"name": "GIANT ZARATHUSTRA FC FIM",
"type": "FUNDQUOTE",
"assetClass": "MULTIMARKET"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1.2,
"exchangeFee": 0.5
},
"createdDate": "2023-04-12T18:57:44.952726Z",
"updatedDate": "2023-04-12T18:57:44.952726Z"
}

Futures​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de DDIF28 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-04-10",
"quantity": 100,
"brokerId": "18945670000146",
"security": {
"isin": "BRBMEFDDI4Z2"
},
"side": "BUY",
"price": 79806.85,
"fees": {
"brokerageFee": 1.20,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "550bfd77-977a-4705-aa1f-bb3b25ba5e2b",
"quantity": 100,
"transactDate": "2023-04-10",
"status": "PROCESSING",
"price": 79806.85,
"side": "BUY",
"security": {
"id": 122675,
"isin": "BRBMEFDDI4Z2",
"name": "DDIF28",
"type": "FUTURES",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1.2,
"exchangeFee": 0.5
},
"createdDate": "2023-04-11T19:15:49.628477Z",
"updatedDate": "2023-04-11T19:15:49.628477Z"
}

Ativos Personalizados (Custom Securities)​

Tipo de identificador aceito para o ativo: securityId.

Para criar uma transação usando um ativo personalizado, você primeiro deve criar o ativo no escopo da sua Organização (Organization). Para saber mais sobre como criar e gerenciar ativos personalizados, clique aqui.

Após criar um ativo personalizado (Custom Security), você pode criar uma transação usando seu securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 100,
"price": 20,
"brokerId": "18945670000146",
"security": {
"id": 63621561
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "a1ecef0a-64a5-4f16-8fe3-9dc6f4b0df37",
"quantity": 100,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 20,
"side": "BUY",
"security": {
"id": 63621561,
"name": "Custom Example",
"type": "GENERIC",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-12T18:57:44.952726Z",
"updatedDate": "2023-04-12T18:57:44.952726Z"
}

Government Bonds (LFT, LTN, NTN-B, NTN-B1, NTN-C, NTN-F)​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de LTN - 01/01/2029 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-04-10",
"quantity": 50,
"brokerId": "18945670000146",
"security": {
"isin": "BRSTNCLTN806"
},
"side": "BUY",
"price": 513.46,
"fees": {
"brokerageFee": 0.10,
"exchangeFee": 0.20
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "a3e1c9d2-6b47-4f0e-9c8a-2d5b7e14f630",
"quantity": 50,
"transactDate": "2023-04-10",
"status": "PROCESSING",
"price": 513.46,
"side": "BUY",
"security": {
"id": 58512279,
"isin": "BRSTNCLTN806",
"name": "LTN - 01/01/2029",
"type": "TREASURY_LOCAL_LTN"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 0.1,
"exchangeFee": 0.2
},
"createdDate": "2023-04-11T14:21:08.517392Z",
"updatedDate": "2023-04-11T14:21:08.517392Z"
}

Index Options​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de IBOVP75 (Vencimento 17/04/2019) usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2019-02-06",
"quantity": 2,
"brokerId": "18945670000146",
"security": {
"id": 7361157
},
"side": "BUY",
"price": 105645
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "6b0d469a-4a27-440b-a0a7-3ff43c2fbb1b",
"quantity": 2,
"transactDate": "2019-02-06",
"status": "PROCESSING",
"price": 105645,
"side": "BUY",
"security": {
"id": 7361157,
"isin": "BRIBOV9P0ID1",
"name": "IBOVP75 (Vencimento em 17/04/2019)",
"type": "OPTION_INDEX",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T23:41:07.112071Z",
"updatedDate": "2023-05-08T23:41:07.112071Z"
}

Stock Forwards​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de PETR4 20/12/2023 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-28",
"quantity": 100,
"brokerId": "18945670000146",
"security": {
"id": 63594844
},
"side": "BUY",
"price": 11.75
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "04a17d40-994b-435f-b15b-92be65e85377",
"quantity": 100,
"transactDate": "2023-03-28",
"status": "PROCESSING",
"price": 11.75,
"side": "BUY",
"security": {
"id": 63594844,
"name": "Termo de PETR4",
"type": "FORWARD_STOCK",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-11T17:27:38.162076Z",
"updatedDate": "2023-04-11T17:27:38.162076Z"
}

Stock Indexes​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de IBRA11 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-09",
"quantity": 10,
"brokerId": "18945670000146",
"security": {
"isin": "BRIBRAINDM10"
},
"side": "BUY",
"price": 16.02
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "fa33365f-843f-42c1-bed8-de7227561c9a",
"quantity": 10,
"transactDate": "2023-03-09",
"status": "PROCESSING",
"price": 16.02,
"side": "BUY",
"security": {
"id": 123819,
"isin": "BRIBRAINDM10",
"name": "IBRA11",
"type": "STOCK_INDEX",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T23:45:34.055864Z",
"updatedDate": "2023-05-08T23:45:34.055864Z"
}

Stock Options​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de PETRL30 usando isin:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-04-11",
"quantity": 120,
"brokerId": "18945670000146",
"security": {
"isin": "BRPETR4L1447"
},
"side": "BUY",
"price": 12.53,
"fees": {
"brokerageFee": 1.20,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "b5d57cbb-6d34-4286-8510-cb97d6396d52",
"quantity": 120,
"transactDate": "2023-04-11",
"status": "PROCESSING",
"price": 12.53,
"side": "BUY",
"security": {
"id": 62598463,
"isin": "BRPETR4L1447",
"name": "PETRL30 (Vencimento em 20/12/2024)",
"type": "OPTION_LOCAL",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1.2,
"exchangeFee": 0.5
},
"createdDate": "2023-04-11T17:12:34.898052Z",
"updatedDate": "2023-04-11T17:12:34.898052Z"
}

Stock Receipts​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de GALG13 (Data de emissão 2022-11-24) usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 100,
"price": 30,
"brokerId": "18945670000146",
"security": {
"id": 43919971
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "d0dfa140-6949-4c0c-a3fd-10ffc80e10af",
"quantity": 100,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 30,
"side": "BUY",
"security": {
"id": 43919971,
"isin": "BRGALGR08M16",
"name": "GALG13 (Emissão em 24/11/2022)",
"type": "STOCK_RECEIPT",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T22:57:29.989154Z",
"updatedDate": "2023-05-08T22:57:29.989154Z"
}

Stock Rights​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de BRHT12 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 1000,
"price": 15,
"brokerId": "18945670000146",
"security": {
"id": 40792064
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "a32c837d-2f30-4b19-8653-07e662713a73",
"quantity": 1000,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 15,
"side": "BUY",
"security": {
"id": 40792064,
"isin": "BRBRHTD01M16",
"name": "BRHT12",
"type": "STOCK_RIGHTS",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T23:01:26.869072Z",
"updatedDate": "2023-05-08T23:01:26.869072Z"
}

Stocks​

Tipos de identificadores aceitos para o ativo: securityId ou ISIN.

Criando uma transação de PETR4 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-04-10",
"quantity": 1000,
"brokerId": "18945670000146",
"security": {
"id": 122720
},
"side": "BUY",
"price": 24.6,
"fees": {
"brokerageFee": 1.78,
"exchangeFee": 0.54
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "07da89c4-623e-4986-ad58-1629454c3cea",
"quantity": 1000,
"transactDate": "2023-04-10",
"status": "PROCESSING",
"price": 24.6,
"side": "BUY",
"security": {
"id": 122720,
"isin": "BRPETRACNPR6",
"name": "PETR4",
"type": "STOCK_LOCAL",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {
"brokerageFee": 1.78,
"exchangeFee": 0.54
},
"createdDate": "2023-04-11T13:22:42.310038Z",
"updatedDate": "2023-04-11T13:22:42.310038Z"
}

Regular - Ativos com quantidade apenas​

Essas transações incluem os seguintes tipos de ativos: Poupança e Caixa.

Esses são ativos que só podem ser transacionados com base no preço de fechamento (final do dia) ou são uma transação de Caixa (Cash), o que significa que você não precisa inserir um preço (price) ao criar uma transação.

Exemplos:

Savings Account - Poupança​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de Poupança (Savings). securityId será sempre 63639335:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 1000,
"brokerId": "18945670000146",
"security": {
"id": 63639335
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "06e9ccda-de6d-4b28-9cc8-19019459baf9",
"quantity": 1000,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"side": "BUY",
"security": {
"id": 63639335,
"name": "Poupança",
"type": "SAVINGS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-05-08T21:51:15.577661Z",
"updatedDate": "2023-05-08T21:51:15.577661Z"
}


Cash (BRL)​

Tipo de identificador aceito para o ativo: securityId.

Criando uma transação de Caixa (Cash). securityId será sempre 177223:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 5000,
"brokerId": "18945670000146",
"security": {
"id": 177223
},
"side": "BUY"
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "44fede0f-c443-414e-a4b8-d45027b1d9e3",
"quantity": 5000,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"side": "BUY",
"security": {
"id": 177223,
"name": "BRL",
"type": "CASH",
"assetClass": "CASH"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"fees": {},
"createdDate": "2023-04-11T20:52:48.794728Z",
"updatedDate": "2023-04-11T20:52:48.794728Z"
}

Regular - Ativos com Taxa de câmbio e Quantidade​

Essas transações são válidas apenas para o tipo de ativo Moedas (Currencies). Atualmente, lidamos apenas com o cálculo de uma carteira em termos de BRL (Real Brasileiro). Isso significa que todas as transações de moeda, por definição, são em relação ao Real Brasileiro.

Exemplo:

Currencies​

Tipo de identificador aceito para o ativo: securityId.

Para moedas como USD, EUR e MXN, inserir um preço não é válido, uma vez que o preço é a própria taxa de câmbio (que é inserida no campo exchangeRate).

Criando uma transação de USD usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 100,
"brokerId": "18945670000146",
"security": {
"id": 130497
},
"side": "BUY",
"exchangeRate": 5.50
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "5d79c866-da8c-4f02-9a3a-746a7a0a02bb",
"quantity": 100,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"side": "BUY",
"security": {
"id": 130497,
"name": "Dólar",
"type": "CURRENCY",
"assetClass": "CURRENCIES"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"exchangeRate": 5.5,
"fees": {},
"createdDate": "2023-04-12T19:18:01.50089Z",
"updatedDate": "2023-04-12T19:18:01.50089Z"
}

Regular - Ativos com Preço, Taxa de câmbio e Quantidade​

Essas transações incluem os seguintes tipos de títulos: Offshore Stocks, Offshore ETFs, Offshore Funds e Offshore REITs.

Atualmente, o Gorila oferece suporte apenas a ativos offshore listados nos Estados Unidos. E, como calculamos as carteiras em termos de BRL, você precisará especificar uma taxa de câmbio (exchangeRate) - além de preço (price) e quantidade (quantity) - em relação ao Real Brasileiro (USDBRL). Isso significa que o preço (price) e quaisquer taxas associadas à transação, como a taxa de corretagem (brokerageFee) e a taxa de bolsa (exchangeFee), precisam ser expressas em USD.

Exemplo:

Offshore Stocks​

Criando uma transação de AAPL usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 50,
"brokerId": "18945670000146",
"price": 160,
"security": {
"id": 135889
},
"side": "BUY",
"exchangeRate": 5.15,
"fees": {
"brokerageFee": 1.20,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "f2909f3f-18f6-479c-99b1-e52e994c5b73",
"quantity": 50,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 160,
"side": "BUY",
"security": {
"id": 135889,
"name": "AAPL",
"type": "OFFSHORE_STOCK",
"assetClass": "OFFSHORE"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"exchangeRate": 5.15,
"fees": {
"brokerageFee": 1.2,
"exchangeFee": 0.5
},
"createdDate": "2023-05-08T23:48:47.122086Z",
"updatedDate": "2023-05-08T23:48:47.122086Z"
}

Offshore ETFs​

Criando uma transação de IAUF usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 30,
"brokerId": "18945670000146",
"price": 20,
"security": {
"id": 132041
},
"side": "BUY",
"exchangeRate": 5.40,
"fees": {
"brokerageFee": 1.00,
"exchangeFee": 0.50
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "8da640c1-9a20-4a62-b334-72e4650bd3e5",
"quantity": 30,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 20,
"side": "BUY",
"security": {
"id": 132041,
"name": "IAUF",
"type": "OFFSHORE_ETF",
"assetClass": "OFFSHORE"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"exchangeRate": 5.4,
"fees": {
"brokerageFee": 1,
"exchangeFee": 0.5
},
"createdDate": "2023-05-09T00:10:41.394989Z",
"updatedDate": "2023-05-09T00:10:41.394989Z"
}

Offshore Funds​

Criando uma transação de VTIVX usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 50,
"brokerId": "18945670000146",
"price": 10,
"security": {
"id": 132200
},
"side": "BUY",
"exchangeRate": 4.40,
"fees": {
"brokerageFee": 1.00,
"exchangeFee": 0.80
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "611dd38c-2ebf-43cd-bce5-58239726e054",
"quantity": 50,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 10,
"side": "BUY",
"security": {
"id": 132200,
"name": "VTIVX",
"type": "OFFSHORE_FUNDQUOTE",
"assetClass": "OFFSHORE"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"exchangeRate": 4.4,
"fees": {
"brokerageFee": 1,
"exchangeFee": 0.8
},
"createdDate": "2023-05-09T00:12:57.911981Z",
"updatedDate": "2023-05-09T00:12:57.911981Z"
}

Offshore REITs​

Criando uma transação de VTR usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "REGULAR",
"transactDate": "2023-03-10",
"quantity": 70,
"brokerId": "18945670000146",
"price": 18,
"security": {
"id": 132580
},
"side": "BUY",
"exchangeRate": 4.53,
"fees": {
"brokerageFee": 0.70,
"exchangeFee": 0.80
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "REGULAR",
"id": "c4efd5aa-6c56-4d72-a63b-af78bce93539",
"quantity": 70,
"transactDate": "2023-03-10",
"status": "PROCESSING",
"price": 18,
"side": "BUY",
"security": {
"id": 132580,
"name": "VTR",
"type": "OFFSHORE_REIT",
"assetClass": "OFFSHORE"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"exchangeRate": 4.53,
"fees": {
"brokerageFee": 0.7,
"exchangeFee": 0.8
},
"createdDate": "2023-05-09T00:15:04.862501Z",
"updatedDate": "2023-05-09T00:15:04.862501Z"
}

Options Exercise​

Exercício significa colocar em prática o direito de comprar ou vender o instrumento financeiro subjacente especificado em um contrato de opções. Se o titular de uma opção decide comprar ou vender o instrumento subjacente em vez de permitir que o contrato expire sem valor ou encerrar a posição, ele estará "exercendo a opção", ou seja, fazendo uso do direito ou privilégio disponível no contrato.

Um titular de opção pode exercer seu direito de comprar ou vender as ações subjacentes do contrato a um preço especificado, também chamado de preço de exercício.

Exercer uma opção de venda (put) permite que você venda o ativo subjacente a um preço especificado dentro de um prazo específico.

Exercer uma opção de compra (call) permite que você compre o ativo subjacente a um preço especificado dentro de um prazo específico.

Para saber mais sobre opções: https://gorila.com.br/blog/o-que-sao-opcoes

Exemplo:

Criando uma transação de PETRL30 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "OPTION_EXERCISE",
"transactDate": "2023-04-11",
"quantity": 50,
"brokerId": "18945670000146",
"security": {
"id": 62598463
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "OPTION_EXERCISE",
"id": "29fc9e31-a5da-4b37-801f-e548d1fe6bf7",
"quantity": 50,
"transactDate": "2023-04-11",
"status": "PROCESSING",
"security": {
"id": 62598463,
"isin": "BRPETR4L1447",
"name": "PETRL30 (Vencimento em 20/12/2024)",
"type": "OPTION_LOCAL",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-12T19:26:57.804214Z",
"updatedDate": "2023-04-12T19:26:57.804214Z"
}

Custody Transfer​

Consiste no procedimento de alteração da instituição responsável pelo registro e proteção de seus investimentos (custodiante), por exemplo, mudar de uma corretora para um banco de investimento e transferir suas aplicações para a nova instituição. Nesse caso, o investidor pode alterar a instituição responsável por sua carteira sem a necessidade de resgatar todos os investimentos feitos.

Exemplo:

Criando uma transação de PETR4 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "CUSTODY_TRANSFER",
"transactDate": "2023-04-11",
"quantity": 500,
"price": 24.64,
"sourceBrokerId": "18945670000146",
"targetBrokerId": "02332886001178",
"security": {
"id": 122720
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "CUSTODY_TRANSFER",
"id": "01032f75-70cc-4d18-a550-e96a24281616",
"quantity": 500,
"transactDate": "2023-04-11",
"status": "PROCESSING",
"price": 24.64,
"security": {
"id": 122720,
"isin": "BRPETRACNPR6",
"name": "PETR4",
"type": "STOCK_LOCAL",
"assetClass": "STOCKS"
},
"sourceBroker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"targetBroker": {
"id": "02332886001178",
"name": "XP INVESTIMENTOS CCTVM"
},
"createdDate": "2023-04-12T19:41:19.037682Z",
"updatedDate": "2023-04-12T19:41:19.037682Z"
}

Come Cotas​

O "Come Cotas" é um pagamento antecipado do Imposto de Renda sobre os rendimentos de alguns fundos de investimento e ocorre no último dia útil de maio e de novembro.

Para saber como funciona o pagamento, visite nosso blog: https://gorila.com.br/blog/come-cotas.

Exemplo:

Criando uma transação de GIANT ZARATHUSTRA FC FIM usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "COME_COTAS",
"transactDate": "2022-11-30",
"quantity": 371.6242843,
"brokerId": "18945670000146",
"security": {
"id": 2407939
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "COME_COTAS",
"id": "b5cc6cea-aba1-4527-960a-add72e9630e4",
"quantity": 371.6242843,
"transactDate": "2022-11-30",
"status": "PROCESSING",
"security": {
"id": 2407939,
"cnpj": "11052478000181",
"name": "GIANT ZARATHUSTRA FC FIM",
"type": "FUNDQUOTE",
"assetClass": "MULTIMARKET"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-12T19:20:30.591252Z",
"updatedDate": "2023-04-12T19:20:30.591252Z"
}

Initial Custody Adjustment​

O ajuste inicial de custódia (INITIAL_CUSTODY_ADJUSTMENT) registra a posição de um ativo em uma data de corte, como ponto de partida dos cálculos, quando não há um histórico confiável de transações anteriores a essa data. A quantidade informada substitui a custódia que a posição tinha até o dia anterior. O preço (price) é opcional: se não for informado, o Gorila usa o preço de fechamento do ativo na data da transação. Para mais detalhes, consulte a documentação de Transação.

Exemplo:

Criando um ajuste inicial de custódia de PETR4 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "INITIAL_CUSTODY_ADJUSTMENT",
"transactDate": "2023-04-11",
"quantity": 300,
"side": "BUY",
"brokerId": "18945670000146",
"security": {
"id": 122720
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "INITIAL_CUSTODY_ADJUSTMENT",
"id": "7d1f4c2a-3b8e-4f5a-9c6d-2e1b0a9f8c7d",
"quantity": 300,
"transactDate": "2023-04-11",
"status": "PROCESSING",
"side": "BUY",
"security": {
"id": 122720,
"isin": "BRPETRACNPR6",
"name": "PETR4",
"type": "STOCK_LOCAL",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-12T19:45:10.512331Z",
"updatedDate": "2023-04-12T19:45:10.512331Z"
}

Position Close​

O fechamento de posição (POSITION_CLOSE) zera a custódia de uma posição ao final do dia da transação. Não é necessário informar a quantidade nem o lado (side): o Gorila calcula a quantidade que zera a posição e a recalcula sempre que o histórico anterior à data do fechamento muda. Para mais detalhes, consulte a documentação de Transação.

Exemplo:

Fechando a posição de GIANT ZARATHUSTRA FC FIM usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "POSITION_CLOSE",
"transactDate": "2023-06-30",
"brokerId": "18945670000146",
"security": {
"id": 2407939
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "POSITION_CLOSE",
"id": "c3a9e7b1-5d2f-4e8a-b6c4-9f0e1d2a3b4c",
"transactDate": "2023-06-30",
"status": "PROCESSING",
"security": {
"id": 2407939,
"cnpj": "11052478000181",
"name": "GIANT ZARATHUSTRA FC FIM",
"type": "FUNDQUOTE",
"assetClass": "MULTIMARKET"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-07-03T14:02:41.108245Z",
"updatedDate": "2023-07-03T14:02:41.108245Z"
}

Stock Receipt Exercise​

⚠️ Não implementado. Em breve. O exemplo abaixo mostra o formato previsto da requisição.

Um recibo de subscrição de ações é um documento que comprova o direito de um investidor adquirir ações de uma empresa a um preço abaixo do valor de mercado.

Ele contém informações como o nome da empresa, o número de ações às quais o investidor tem direito de comprar, o preço de subscrição, a data de vencimento e as condições associadas à subscrição.

O exercício do recibo ocorre quando o titular decide comprar as ações pelo preço de subscrição especificado no recibo. No Gorila, como depende da escolha do usuário, é necessário inserir a operação de recibo de subscrição, e na data de vencimento do recibo, ele é automaticamente convertido no título em questão.

Exemplo:

Criando uma transação de EVBI13 emissão 20/12/2022 usando securityId:

// REQUEST
// POST https://core.gorila.com.br/portfolios/{portfolioId}/transactions

{
"type": "SUBSCRIPTION_EXERCISE",
"transactDate": "2022-12-22",
"quantity": 50,
"brokerId": "18945670000146",
"security": {
"id": 62599573
}
}

Isso irá retornar uma resposta como esta:

//RESPONSE

{
"type": "SUBSCRIPTION_EXERCISE",
"id": "b88058d1-9a99-47b1-9e19-bbc3e969d5af",
"quantity": 50,
"transactDate": "2022-12-22",
"status": "PROCESSING",
"security": {
"id": 62599573,
"isin": "BREVBIR03M18",
"name": "EVBI13 (Emissão em 20/12/2022)",
"type": "STOCK_RECEIPT",
"assetClass": "STOCKS"
},
"broker": {
"id": "18945670000146",
"name": "INTER DTVM"
},
"createdDate": "2023-04-13T18:42:46.779592Z",
"updatedDate": "2023-04-13T18:42:46.779592Z"
}