{"openapi":"3.0.0","paths":{"/benchmarks":{"get":{"description":"List all available Benchmarks in Gorila","operationId":"List Benchmarks","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name or information of a benchmark","schema":{"minLength":1,"example":"IPCA","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenchmarkPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Benchmarks"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/benchmarks' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/benchmarks' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/benchmarks/{benchmarkId}":{"get":{"description":"Benchmarks returns for a specific period with many altering properties available.","operationId":"Read Benchmark by ID","parameters":[{"name":"benchmarkId","required":true,"in":"path","description":"Desired target benchmark for request","schema":{"minLength":1,"type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"startDate","required":true,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"multiplier","required":false,"in":"query","description":"Desired multiplier. If target is 110% of benchmark it should be ratio=1.1","schema":{"format":"float","default":1,"type":"number"}},{"name":"spread","required":false,"in":"query","description":"Desired spread. If target is benchmark -5% it should be spread=-0.05","schema":{"format":"float","default":0,"type":"number"}},{"name":"calculationMethod","required":false,"in":"query","description":"Standard of return for benchmark timeseries","schema":{"default":"INDEX","type":"string","enum":["INTEREST","INDEX","AUTO"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenchmarkTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Benchmarks"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/benchmarks/string?frequency=DAILY&seriesType=PER_PERIOD&startDate=iso8601%20%28YYYY-MM-DD%29' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/benchmarks/string?frequency=DAILY&seriesType=PER_PERIOD&startDate=iso8601%20%28YYYY-MM-DD%29' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/brokers":{"get":{"description":"List of all available Brokerage Houses in Gorila.","operationId":"List Brokers","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name or information of a Broker","schema":{"minLength":1,"example":"corretora de valores","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokerPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Brokers"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/brokers' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/brokers' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/brokers/{brokerId}":{"get":{"description":"Read all available information of a brokerage house by its Id","operationId":"Read Broker by ID","parameters":[{"name":"brokerId","required":true,"in":"path","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokerDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"404":{"description":"Broker not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Brokers"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/brokers/string' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/brokers/string' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/drawdown":{"get":{"description":"Returns the time series of the drawdown from a chosen period.","operationId":"Read Economic Group Drawdown","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupDrawdownTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Drawdown"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/drawdown' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/drawdown' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups":{"post":{"description":"Creates a new economic group.","operationId":"Create Economic Group","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupCreateDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/economic-groups' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"Doe Family Group\",\"portfolios\":[\"uuid\"]}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups' -Method POST -Headers $headers -Body '{\"name\":\"Doe Family Group\",\"portfolios\":[\"uuid\"]}'\nWrite-Output $response"}]},"get":{"description":"Reads all economic groups associated with authenticated user.","operationId":"List Economic Groups","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search Economic Groups by name","schema":{"minLength":3,"example":"Familia Marques","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}":{"get":{"description":"Reads target economic group by its ID.","operationId":"Read Economic Group by ID","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid' -Method GET -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Updates target economic group by its ID.","operationId":"Update Economic Group by ID","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/economic-groups/uuid' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]},"delete":{"description":"Deletes target economic group by its ID.","operationId":"Delete Economic Group by ID","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/economic-groups/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/invested-amount":{"get":{"description":"Reads a time series of invested amount of target Economic Group.","operationId":"Read Economic Group Invested Amount","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupInvestedAmountTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Invested Amount"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/invested-amount?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/invested-amount?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/liquidity":{"get":{"description":"Returns the aggregated liquidity of an economic group, grouped into fixed day ranges.","operationId":"Read Economic Group Liquidity","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupLiquidityDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Liquidity"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/liquidity' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/liquidity' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/nav":{"get":{"description":"Reads a time series of net asset value of target Economic Group.","operationId":"Read Economic Group Net Asset Value","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupNavTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Net Asset Value"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/nav?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/nav?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/pnl":{"get":{"description":"Reads a time series of profit and losses value of target Economic Group.","operationId":"Read Economic Group Profit & Losses","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupPnlTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Profit & Losses"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/pnl?frequency=DAILY&seriesType=PER_PERIOD' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/pnl?frequency=DAILY&seriesType=PER_PERIOD' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/average-prices":{"get":{"description":"Returns the average price for each position in an economic group for a given date.","operationId":"List Economic Group Positions Average Prices","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupAveragePricePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Average Price"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/average-prices' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/average-prices' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions":{"get":{"description":"Returns all non-zeroed positions of target Economic Group.","operationId":"List Economic Group Positions","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"positionState","required":false,"in":"query","description":"Filter by position state","schema":{"default":"OPEN","type":"string","enum":["OPEN","CLOSED","ALL"]}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupPositionPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Positions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/irr":{"get":{"description":"Returns the IRRs for each position in selected period for target Economic Group.","operationId":"List Economic Group Positions Internal Rate of Return","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupIrrPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Internal Rate of Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/irr' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/irr' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/market-values":{"get":{"description":"Returns the Market Value for each position on a given date for target Economic Group.","operationId":"List Economic Group Positions Market Values","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EconomicGroupMarketValueRecordPageDto"},{"$ref":"#/components/schemas/EconomicGroupMarketValueGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Market Values"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/market-values' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/market-values' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/invested-amount":{"get":{"description":"Returns the Invested Amount for each position in selected period for target Economic Group.","operationId":"List Economic Group Positions Invested Amount","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EconomicGroupPositionInvestedAmountRecordPageDto"},{"$ref":"#/components/schemas/EconomicGroupPositionInvestedAmountGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Invested Amount"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/invested-amount' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/invested-amount' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/liquidity":{"get":{"description":"Returns, for a given economic group, the liquidity (in days) of all its portfolio positions.","operationId":"List Economic Group Position Liquidity","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupPositionLiquidityPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Liquidity"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/liquidity' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/liquidity' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/pnl":{"get":{"description":"Returns the PnL for each position in selected period for target Economic Group.","operationId":"List Economic Group Positions Profit & Losses","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EconomicGroupPositionPnlRecordPageDto"},{"$ref":"#/components/schemas/EconomicGroupPositionPnlGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Profit & Losses"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/pnl' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/pnl' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/twr":{"get":{"description":"Time-weighted return of each position in selected period for target Economic Group.","operationId":"List Economic Group Positions Time-Weighted Returns","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}},{"name":"type","required":false,"in":"query","description":"Choice of type of cost reference for the profit","schema":{"default":"GROSS_UP","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EconomicGroupPositionTwrRecordPageDto"},{"$ref":"#/components/schemas/EconomicGroupPositionTwrGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Time-Weighted Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/twr' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/twr' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/positions/security-prices":{"get":{"description":"Last available price of each position on a given date for target Economic Group.","operationId":"List Economic Group Positions Security Prices","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupSecurityPricePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Group Positions Security Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/positions/security-prices' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/positions/security-prices' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/security-events":{"get":{"description":"Lists all security events of all portfolios for a selected period of target Economic Group.","operationId":"List Economic Group Security Events","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Security's unique identifier","schema":{"format":"integer","example":"1165","type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupSecurityEventPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/security-events' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/security-events' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/sharpe-ratio":{"get":{"description":"Returns the Sharpe Ratio data for the specified economic group","operationId":"Read Economic Group Sharpe Ratio","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the Sharpe ratio at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupSharpeRatioTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Sharpe Ratio"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/sharpe-ratio?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/sharpe-ratio?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/transactions":{"get":{"description":"Returns all transactions of target Economic Group.","operationId":"List Economic Group Transactions","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"type","required":false,"in":"query","description":"Transaction type being created","schema":{"minLength":1,"example":"TRANSFER_INITIAL_CUSTODY_SUGGESTION","type":"string","enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"]}},{"name":"side","required":false,"in":"query","description":"Direction of the transaction","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"createdDateFrom","required":false,"in":"query","description":"Filter transactions with creation date greater than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-01-01","type":"string"}},{"name":"createdDateTo","required":false,"in":"query","description":"Filter transactions with creation date less than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-12-31","type":"string"}},{"name":"updatedDateFrom","required":false,"in":"query","description":"Filter transactions with updated date greater than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-01-01","type":"string"}},{"name":"updatedDateTo","required":false,"in":"query","description":"Filter transactions with updated date less than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-12-31","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupTransactionPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/transactions' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/transactions' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/twr":{"get":{"description":"Returns the time series of the TWR from a chosen period.","operationId":"Read Economic Group Time-Weighted Return","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}},{"name":"type","required":false,"in":"query","description":"Choice of type of cost reference for the profit","schema":{"default":"GROSS_UP","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupTwrTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Time-Weighted Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/twr?frequency=DAILY&seriesType=PER_PERIOD' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/twr?frequency=DAILY&seriesType=PER_PERIOD' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/economic-groups/{economicGroupId}/volatility":{"get":{"description":"Returns the volatility data for the specified economic group","operationId":"Read Economic Group Volatility","parameters":[{"name":"economicGroupId","required":true,"in":"path","description":"Economic group's UUID","schema":{"format":"uuid","example":"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the volatility at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicGroupVolatilityTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Economic Groups Volatility"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/economic-groups/uuid/volatility?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/economic-groups/uuid/volatility?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/investment-profiles":{"post":{"description":"Creates a new investment profile for the organization.","operationId":"Create Investment Profile","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfileCreateDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfileDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Investment Profiles"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/investment-profiles' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"Conservador\",\"classifications\":[{\"id\":\"VARIABLE_INCOME_STOCKS\",\"percentage\":0.65}]}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/investment-profiles' -Method POST -Headers $headers -Body '{\"name\":\"Conservador\",\"classifications\":[{\"id\":\"VARIABLE_INCOME_STOCKS\",\"percentage\":0.65}]}'\nWrite-Output $response"}]},"get":{"description":"Returns a paginated list of investment profiles for the organization. Classifications are omitted from this endpoint.","operationId":"List Investment Profiles","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search term to filter profiles by name (case-insensitive partial match)","schema":{"minLength":3,"example":"Conservador","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfilePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Investment Profiles"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/investment-profiles' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/investment-profiles' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/investment-profiles/{investmentProfileId}":{"get":{"description":"Returns a single investment profile including all classifications.","operationId":"Get Investment Profile By Id","parameters":[{"name":"investmentProfileId","required":true,"in":"path","description":"Unique identifier of the investment profile","schema":{"format":"uuid","example":"499e88ab-b703-4f94-818e-4476fbb6d11a","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfileDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Investment Profiles"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/investment-profiles/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/investment-profiles/uuid' -Method GET -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Partially updates an investment profile. When classifications is provided, the entire set is replaced.","operationId":"Update Investment Profile","parameters":[{"name":"investmentProfileId","required":true,"in":"path","description":"Unique identifier of the investment profile","schema":{"format":"uuid","example":"499e88ab-b703-4f94-818e-4476fbb6d11a","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfileUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentProfileDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Investment Profiles"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/investment-profiles/uuid' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/investment-profiles/uuid' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]},"delete":{"description":"Deletes an investment profile. Associated portfolios are automatically disassociated.","operationId":"Delete Investment Profile","parameters":[{"name":"investmentProfileId","required":true,"in":"path","description":"Unique identifier of the investment profile","schema":{"format":"uuid","example":"499e88ab-b703-4f94-818e-4476fbb6d11a","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Investment Profiles"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/investment-profiles/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/investment-profiles/uuid' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/issuers":{"get":{"description":"List of all available Issuers in Gorila.","operationId":"List Issuers","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name or information of an Issuer","schema":{"minLength":1,"example":"tvm","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Issuers"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/issuers' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/issuers' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/issuers/{issuerId}":{"get":{"description":"Read all available information of an issuer by its ID.","operationId":"Read Issuer by ID","parameters":[{"name":"issuerId","required":true,"in":"path","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","schema":{"example":"12ABC34501DE35","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"404":{"description":"Issuer not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Issuers"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/issuers/string' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/issuers/string' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/drawdown":{"get":{"description":"Returns the time series of the drawdown from a chosen period.","operationId":"Read Drawdown","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawdownTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Drawdown"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/drawdown' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/drawdown' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/invested-amount":{"get":{"description":"Reads a time series of invested amount of target portfolio.","operationId":"Read Invested Amount","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestedAmountTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Invested Amount"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/invested-amount?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/invested-amount?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/liquidity":{"get":{"description":"Returns the aggregated liquidity of a portfolio, grouped into fixed day ranges.","operationId":"Read Portfolio Liquidity","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidityDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Liquidity"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/liquidity' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/liquidity' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/nav":{"get":{"description":"Reads a time series of net asset value of target portfolio.","operationId":"Read Net Asset Value","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Net Asset Value"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/nav?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/nav?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/pnl":{"get":{"description":"Portfolio return during a specific period the nominal (PnL) value.","operationId":"Read Profit & Losses","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PnlTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Profit & Losses"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/pnl?frequency=DAILY&seriesType=PER_PERIOD' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/pnl?frequency=DAILY&seriesType=PER_PERIOD' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios":{"post":{"description":"Creates a new portfolio.","operationId":"Create Portfolio","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioCreateDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolios"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/portfolios' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"John Doe Portfolio\",\"autoRnC\":false}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios' -Method POST -Headers $headers -Body '{\"name\":\"John Doe Portfolio\",\"autoRnC\":false}'\nWrite-Output $response"}]},"get":{"description":"Reads all portfolios associated with authenticated user.","operationId":"List Portfolios","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search portfolio by name","schema":{"minLength":3,"example":"John","type":"string"}},{"name":"createdDateFrom","required":false,"in":"query","description":"Filter portfolios created from this date","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2024-01-01","type":"string"}},{"name":"createdDateTo","required":false,"in":"query","description":"Filter portfolios created up to this date","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2024-01-01","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolios"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}":{"get":{"description":"Reads target portfolio by its ID.","operationId":"Read Portfolio by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolios"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid' -Method GET -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Updates target portfolio by its ID.","operationId":"Update Portfolio by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolios"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/portfolios/uuid' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]},"delete":{"description":"Deletes target portfolio by its ID.","operationId":"Delete Portfolio by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolios"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/portfolios/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/allocation":{"get":{"description":"Returns the allocation weight of each position relative to the total portfolio exposure.","operationId":"Get Portfolio Positions Allocation","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"investmentProfileRelation","required":false,"in":"query","description":"Filter positions based on the portfolio investment profile classification chain","schema":{"default":"ALL","type":"string","enum":["ALL","IN","OUT"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AllocationRecordPageDto"},{"$ref":"#/components/schemas/AllocationGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Allocation"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/allocation' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/allocation' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/average-prices":{"get":{"description":"Returns the average price for each position in a portfolio for a given date.","operationId":"List Position Average Prices","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AveragePricePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Average Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/average-prices' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/average-prices' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/dividend-yield":{"get":{"description":"Returns list of position dividend yield","operationId":"List Position Dividend Yield","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DividendYieldPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Dividend Yield"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/dividend-yield' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/dividend-yield' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/irr":{"get":{"description":"List the IRRs of each position for the selected period.","operationId":"List Position Internal Rate of Return","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrrPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Internal Rate of Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/irr' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/irr' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/liquidity":{"get":{"description":"Returns, for a given portfolio, the liquidity (in days) of all its positions.","operationId":"List Position Liquidity","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidityPositionPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Liquidity"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/liquidity' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/liquidity' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/market-values":{"get":{"description":"Returns, for a given portfolio, the market value of all its positions.","operationId":"List Position Market Values","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MarketValueRecordPageDto"},{"$ref":"#/components/schemas/MarketValueGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Market Values"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/market-values' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/market-values' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/invested-amount":{"get":{"description":"Invested Amount of each position for the selected period.","operationId":"List Position Invested Amount","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PositionInvestedAmountRecordPageDto"},{"$ref":"#/components/schemas/PositionInvestedAmountGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Invested Amount"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/invested-amount' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/invested-amount' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/pnl":{"get":{"description":"PnL of each position for the selected period.","operationId":"List Position Profit & Losses","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PositionPnlRecordPageDto"},{"$ref":"#/components/schemas/PositionPnlGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Profit & Losses"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/pnl' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/pnl' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/twr":{"get":{"description":"Time-weighted return of each position for the selected period.","operationId":"List Position Time-Weighted Returns","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"groupBy","required":false,"in":"query","description":"Grouping of the calculated value","schema":{"example":"SECURITY_ASSET_CLASS","type":"string","enum":["BROKER_ID","SECURITY_ID","SECURITY_TYPE","SECURITY_ASSET_CLASS","CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}},{"name":"type","required":false,"in":"query","description":"Choice of type of cost reference for the profit","schema":{"default":"GROSS_UP","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PositionTwrRecordPageDto"},{"$ref":"#/components/schemas/PositionTwrGroupPageDto"}]}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Time-Weighted Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/twr' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/twr' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions":{"get":{"description":"Returns all non-zeroed positions of target portfolio.","operationId":"List Positions","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"positionState","required":false,"in":"query","description":"Filter by position state","schema":{"default":"OPEN","type":"string","enum":["OPEN","CLOSED","ALL"]}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Positions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/positions/security-prices":{"get":{"description":"Last available price of each position for the selected date.","operationId":"List Position Security Prices","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date to perform operation","schema":{"format":"iso8601","example":"2022-01-01","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionSecurityPricePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Position Security Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/positions/security-prices' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/positions/security-prices' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/security-events":{"get":{"description":"List all security events of a portfolio for a selected period.","operationId":"List Security Events","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Security's unique identifier","schema":{"format":"integer","example":"1165","type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioSecurityEventPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolio Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/security-events' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/security-events' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/sharpe-ratio":{"get":{"description":"Returns the Sharpe Ratio data for the specified portfolio","operationId":"Read Sharpe Ratio","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the Sharpe ratio at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharpeRatioTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Sharpe Ratio"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/sharpe-ratio?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/sharpe-ratio?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/target-allocation":{"get":{"description":"Returns the target allocation status for a portfolio based on its investment profile.","operationId":"Get Portfolio Target Allocation","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"referenceDate","required":false,"in":"query","description":"Reference date for the target allocation calculation. Defaults to today.","schema":{"format":"iso8601","example":"2024-06-30","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetAllocationDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Portfolio Target Allocation"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/target-allocation' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/target-allocation' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/transactions":{"post":{"description":"Creates a new transaction","operationId":"Create Transaction","parameters":[{"name":"idempotency-key","required":false,"in":"header","description":"Client side unique transaction identifier","schema":{"minLength":1,"type":"string"}},{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularCreateDto"},{"$ref":"#/components/schemas/TransactionPositionCloseCreateDto"},{"$ref":"#/components/schemas/TransactionComeCotasCreateDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseCreateDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseCreateDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferCreateDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentCreateDto"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR":"#/components/schemas/TransactionRegularCreateDto","POSITION_CLOSE":"#/components/schemas/TransactionPositionCloseCreateDto","COME_COTAS":"#/components/schemas/TransactionComeCotasCreateDto","OPTION_EXERCISE":"#/components/schemas/TransactionOptionExerciseCreateDto","SUBSCRIPTION_EXERCISE":"#/components/schemas/TransactionSubscriptionExerciseCreateDto","CUSTODY_TRANSFER":"#/components/schemas/TransactionCustodyTransferCreateDto","INITIAL_CUSTODY_ADJUSTMENT":"#/components/schemas/TransactionInitialCustodyAdjustmentCreateDto"}}}}}},"responses":{"201":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularDto"},{"$ref":"#/components/schemas/TransactionPositionCloseDto"},{"$ref":"#/components/schemas/TransactionComeCotasDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentDto"}]},"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"409":{"description":"Idempotency key conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionConflictDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/portfolios/uuid/transactions' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/transactions' -Method POST -Headers $headers\nWrite-Output $response"}]},"get":{"description":"Reads the collection of transactions with pagination support","operationId":"List Transactions","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"type","required":false,"in":"query","description":"Transaction type being created","schema":{"minLength":1,"example":"TRANSFER_INITIAL_CUSTODY_SUGGESTION","type":"string","enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"]}},{"name":"side","required":false,"in":"query","description":"Direction of the transaction","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"createdDateFrom","required":false,"in":"query","description":"Filter transactions with creation date greater than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-01-01","type":"string"}},{"name":"createdDateTo","required":false,"in":"query","description":"Filter transactions with creation date less than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-12-31","type":"string"}},{"name":"updatedDateFrom","required":false,"in":"query","description":"Filter transactions with updated date greater than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-01-01","type":"string"}},{"name":"updatedDateTo","required":false,"in":"query","description":"Filter transactions with updated date less than or equal to this value","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2023-12-31","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/transactions' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/transactions' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/transactions/{transactionId}":{"get":{"description":"Reads target transaction by its ID","operationId":"Read Transaction by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"transactionId","required":true,"in":"path","description":"Target transaction unique ID","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Success","schema":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularDto"},{"$ref":"#/components/schemas/TransactionPositionCloseDto"},{"$ref":"#/components/schemas/TransactionComeCotasDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferDto"},{"$ref":"#/components/schemas/TransactionCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionTransferCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionTransferInitialCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentDto"}]},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' -Method GET -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Updates target transaction partially by its ID","operationId":"Update Transaction by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"transactionId","required":true,"in":"path","description":"Target transaction unique ID","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionUpdateDto"}}}},"responses":{"200":{"description":"Success","schema":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularDto"},{"$ref":"#/components/schemas/TransactionPositionCloseDto"},{"$ref":"#/components/schemas/TransactionComeCotasDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferDto"},{"$ref":"#/components/schemas/TransactionCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentDto"},{"$ref":"#/components/schemas/TransactionTransferCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionTransferInitialCustodySuggestionDto"}]},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]},"delete":{"description":"Deletes target transaction by its ID","operationId":"Delete Transaction by ID","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"transactionId","required":true,"in":"path","description":"Target transaction unique ID","schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Transactions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/transactions/uuid' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/twr":{"get":{"description":"Returns the time series of the TWR from a chosen period.","operationId":"Read Time-Weighted Return","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"marketValueType","required":false,"in":"query","description":"Defines the valuation method: auto switches between net worth and exposure based on the grouping, while exposure always uses exposure-based values","schema":{"default":"AUTO","type":"string","enum":["AUTO","EXPOSURE"]}},{"name":"type","required":false,"in":"query","description":"Choice of type of cost reference for the profit","schema":{"default":"GROSS_UP","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwrTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Time-Weighted Return"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/twr?frequency=DAILY&seriesType=PER_PERIOD' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/twr?frequency=DAILY&seriesType=PER_PERIOD' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/portfolios/{portfolioId}/volatility":{"get":{"description":"Returns the volatility data for the specified portfolio","operationId":"Read Volatility","parameters":[{"name":"portfolioId","required":true,"in":"path","description":"Target portfolio unique ID","schema":{"format":"uuid","type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"brokerId","required":false,"in":"query","description":"National identifier of the custodian institution","schema":{"minLength":1,"example":"10721160000183","type":"string"}},{"name":"securityId","required":false,"in":"query","description":"Gorila's internal identification of the Security","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"securityIsin","required":false,"in":"query","description":"International Securities Identification Number","schema":{"pattern":"[A-Z]{2}[\\dA-Z]{9}\\d","example":"US9311421039","type":"string"}},{"name":"securityCnpj","required":false,"in":"query","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","schema":{"example":"12ABC34501DE35","type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"excludeSecurityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security to exclude","schema":{"minLength":1,"example":["VARIABLE_INCOME"],"type":"array","items":{"type":"string"}}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the volatility at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolatilityTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Volatility"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/portfolios/uuid/volatility?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/portfolios/uuid/volatility?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/security-events/types":{"get":{"description":"List all available Security Event Types in Gorila","operationId":"List Security Event Types","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name or information of a SecurityEventType","schema":{"minLength":1,"example":"bonificação","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEventTypePageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/security-events/types' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/security-events/types' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/classifications":{"post":{"description":"Creates a new security classification.","operationId":"Create Security Classification","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationCreateBaseDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Classifications"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/securities/classifications' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"Multimercado\",\"level\":\"CLASSIFICATION_L0\"}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/classifications' -Method POST -Headers $headers -Body '{\"name\":\"Multimercado\",\"level\":\"CLASSIFICATION_L0\"}'\nWrite-Output $response"}]},"get":{"description":"List all securities classifications.","operationId":"List Securities Classifications","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"parentId","required":false,"in":"query","description":"Search parameter used to match part of the name of information of a Security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"classificationLevel","required":false,"in":"query","description":"Classification level of the security","schema":{"example":"CLASSIFICATION_L1","type":"string","enum":["CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name of a Security Classification","schema":{"minLength":1,"example":"Renda Variável","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationsPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Classifications"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/classifications' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/classifications' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/classifications/{classificationId}":{"get":{"description":"Read target security classification by its ID.","operationId":"Read Classification by ID","parameters":[{"name":"classificationId","required":true,"in":"path","description":"The unique identifier of the security classification.","schema":{"minLength":1,"example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Classifications"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/classifications/string' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/classifications/string' -Method GET -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Updates the name of a security classification.","operationId":"Update Security Classification by ID","parameters":[{"name":"classificationId","required":true,"in":"path","description":"The unique identifier of the security classification.","schema":{"minLength":1,"example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityClassificationDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Classifications"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/securities/classifications/string' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"name\":\"Multimercado\"}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/classifications/string' -Method PATCH -Headers $headers -Body '{\"name\":\"Multimercado\"}'\nWrite-Output $response"}]},"delete":{"description":"Deletes a security classification by its ID.","operationId":"Delete Security Classification by ID","parameters":[{"name":"classificationId","required":true,"in":"path","description":"The unique identifier of the security classification.","schema":{"minLength":1,"example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Classifications"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/securities/classifications/string' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/classifications/string' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/events":{"get":{"description":"Lists custom events for a specific security.","operationId":"List Security Custom Events","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"types","required":false,"in":"query","description":"Types of security events to filter","schema":{"example":["EXPIRATION","CASH_DIVIDEND"],"type":"array","items":{"type":"string","enum":["EXPIRATION","CASH_AMORTIZATION","CASH_AMORTIZATION_UNSCHEDULED","CASH_DIVIDEND","CASH_INCOME","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL"]}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEventPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/events' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/events' -Method GET -Headers $headers\nWrite-Output $response"}]},"post":{"description":"Creates a custom event for a security.","operationId":"Create Security Event","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SecurityExpirationEventCreateDto"},{"$ref":"#/components/schemas/SecurityCashEventCreateDto"}],"discriminator":{"propertyName":"type","mapping":{"EXPIRATION":"#/components/schemas/SecurityExpirationEventCreateDto","CASH_AMORTIZATION":"#/components/schemas/SecurityCashEventCreateDto","CASH_AMORTIZATION_UNSCHEDULED":"#/components/schemas/SecurityCashEventCreateDto","CASH_DIVIDEND":"#/components/schemas/SecurityCashEventCreateDto","CASH_INCOME":"#/components/schemas/SecurityCashEventCreateDto","CASH_INTEREST":"#/components/schemas/SecurityCashEventCreateDto","CASH_JSCP":"#/components/schemas/SecurityCashEventCreateDto","CASH_PREMIUM":"#/components/schemas/SecurityCashEventCreateDto","CASH_RETURN_OF_CAPITAL":"#/components/schemas/SecurityCashEventCreateDto"}}}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEventDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/securities/1/events' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/events' -Method POST -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/events/{eventId}":{"patch":{"description":"Updates a custom event for a security.","operationId":"Update Security Event","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"eventId","required":true,"in":"path","description":"Security event's unique identifier","schema":{"format":"integer","example":12345,"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEventUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityEventDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/securities/1/events/1' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/events/1' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]},"delete":{"description":"Deletes a custom event from a security.","operationId":"Delete Security Event","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"eventId","required":true,"in":"path","description":"Security event's unique identifier","schema":{"format":"integer","example":12345,"type":"number"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Events"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/securities/1/events/1' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/events/1' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/drawdown":{"get":{"description":"Returns the security's drawdown timeseries: the percentage decline from its running peak value.","operationId":"Read Security Drawdown","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"type","required":false,"in":"query","description":"Return basis for the drawdown: `GROSS` uses the raw returns, while `GROSS_UP` grosses up tax-exempt income, making it comparable with taxable securities","schema":{"default":"GROSS","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityDrawdownTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security KPIs"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/drawdown' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/drawdown' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/twr":{"get":{"description":"Reads the Time-Weighted Return of a security by its ID.","operationId":"Read Security Time-Weighted Return","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"seriesType","required":true,"in":"query","description":"Desired type of accrual for series: either not carrying values over periods or accumulating them","schema":{"type":"string","enum":["PER_PERIOD","ACCUMULATED"]}},{"name":"type","required":false,"in":"query","description":"Return basis for the TWR: `GROSS` uses the raw returns, while `GROSS_UP` grosses up tax-exempt income, making it comparable with taxable securities","schema":{"default":"GROSS","type":"string","enum":["GROSS","GROSS_UP"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityTwrDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security KPIs"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/twr?frequency=DAILY&seriesType=PER_PERIOD' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/twr?frequency=DAILY&seriesType=PER_PERIOD' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/volatility":{"get":{"description":"Returns the security's volatility timeseries: the standard deviation of its returns over a specified period.","operationId":"Read Security Volatility","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the volatility at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityVolatilityTimeDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security KPIs"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/volatility?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/volatility?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}/sharpe-ratio":{"get":{"description":"Returns the securitys Sharpe Ratio: a single interval value and a timeseries at the requested frequency, calculated using the given window","operationId":"Read Security Sharpe Ratio","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}},{"name":"frequency","required":true,"in":"query","description":"Frequency to generate data points","schema":{"type":"string","enum":["DAILY","MONTHLY","YEARLY","INTERVAL"]}},{"name":"calculateWindow","required":false,"in":"query","description":"Window of past returns used to calculate the Sharpe ratio at each data point","schema":{"default":"12M","type":"string","enum":["3M","6M","12M","24M","PER_FREQUENCY"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySharpeRatioDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security KPIs"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/sharpe-ratio?frequency=DAILY' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/sharpe-ratio?frequency=DAILY' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/price-conversions":{"post":{"description":"Returns price and quantity for a given security's transactional information.","operationId":"Price Conversion","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceConversionCreateDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceConversionDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Price Conversions"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/securities/price-conversions' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"date\":\"2023-06-23\"}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/price-conversions' -Method POST -Headers $headers -Body '{\"date\":\"2023-06-23\"}'\nWrite-Output $response"}]}},"/securities/{securityId}/prices":{"get":{"description":"List prices of a custom security.","operationId":"List Security Prices","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}},{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"startDate","required":false,"in":"query","description":"Starting date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-01-01","type":"string"}},{"name":"endDate","required":false,"in":"query","description":"Ending date to perform operation","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2021-12-31","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityTimeSeriesPricesPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1/prices' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/prices' -Method GET -Headers $headers\nWrite-Output $response"}]},"put":{"description":"Create prices of a custom security.","operationId":"Upsert Security Prices","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPriceUpsertDto"}}}},"responses":{"200":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PUT \\\n--url 'https://core.gorila.com.br/securities/1/prices' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{\"prices\":[{\"referenceDate\":\"2022-04-04\",\"price\":100}]}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/prices' -Method PUT -Headers $headers -Body '{\"prices\":[{\"referenceDate\":\"2022-04-04\",\"price\":100}]}'\nWrite-Output $response"}]}},"/securities/{securityId}/prices/{referenceDate}":{"delete":{"description":"Delete price point of a custom security.","operationId":"Delete Security Prices","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","example":1651,"type":"number"}},{"name":"referenceDate","required":true,"in":"path","description":"Date of reference for the price","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2022-04-04","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Security Prices"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/securities/1/prices/iso8601 (YYYY-MM-DD)' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1/prices/iso8601 (YYYY-MM-DD)' -Method DELETE -Headers $headers\nWrite-Output $response"}]}},"/securities":{"post":{"description":"With this request an Organization can create and make available for Transactions some specific securities.","operationId":"Create Security","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SecurityForwardStockCreateDto"},{"$ref":"#/components/schemas/SecurityForwardFiiCreateDto"},{"$ref":"#/components/schemas/SecurityForwardBdrCreateDto"},{"$ref":"#/components/schemas/SecurityFixRateBankingBondCreateDto"},{"$ref":"#/components/schemas/SecurityFloatingRateBankingBondCreateDto"},{"$ref":"#/components/schemas/SecurityCustomCreateDto"},{"$ref":"#/components/schemas/SecurityInvestmentClubCreateDto"},{"$ref":"#/components/schemas/SecurityManagedFundCreateDto"}],"discriminator":{"propertyName":"type","mapping":{"FORWARD_STOCK":"#/components/schemas/SecurityForwardStockCreateDto","FORWARD_FII":"#/components/schemas/SecurityForwardFiiCreateDto","FORWARD_BDR":"#/components/schemas/SecurityForwardBdrCreateDto","FIXED_RATE_BANKING_BOND":"#/components/schemas/SecurityFixRateBankingBondCreateDto","FLOATING_RATE_BANKING_BOND":"#/components/schemas/SecurityFloatingRateBankingBondCreateDto","CUSTOM":"#/components/schemas/SecurityCustomCreateDto","INVESTMENT_CLUB":"#/components/schemas/SecurityInvestmentClubCreateDto","MANAGED_FUND":"#/components/schemas/SecurityManagedFundCreateDto"}}}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityIdDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Securities"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n--url 'https://core.gorila.com.br/securities' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities' -Method POST -Headers $headers\nWrite-Output $response"}]},"get":{"description":"This endpoint facilitates the retrieval of securities corresponding to the specified keywords.\n    Be advised that the returned data may experience delays for recently created securities, potentially resulting\n    in information that is not the most up-to-date.","operationId":"List Securities","parameters":[{"name":"limit","required":false,"in":"query","description":"Amount of records to read, returns all if available entries are less than specified","schema":{"minimum":1,"maximum":1000,"format":"integer","default":100,"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"Token to fetch target page, returns first when omitted","schema":{"type":"string"}},{"name":"securityAssetClass","required":false,"in":"query","description":"Highest order of security classification","schema":{"example":"FIXED_INCOME","type":"string","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]}},{"name":"securityType","required":false,"in":"query","description":"Gorila's type classification of the position's security","schema":{"example":["STOCK_LOCAL"],"type":"array","items":{"type":"string"}}},{"name":"securityClassification","required":false,"in":"query","description":"Gorila's internal classification of the security","schema":{"minLength":1,"example":"VARIABLE_INCOME","type":"string"}},{"name":"search","required":false,"in":"query","description":"Search parameter used to match part of the name of information of a Security","schema":{"minLength":1,"example":"petróleo","type":"string"}},{"name":"searchExactMatch","required":false,"in":"query","description":"Indicates whether the search should be an exact match or not","schema":{"default":false,"example":true,"type":"boolean"}},{"name":"securityProvider","required":false,"in":"query","description":"Identification of the provider of securities' prices and information","schema":{"example":"ORGANIZATION","type":"string","enum":["ORGANIZATION"]}},{"name":"createdDateFrom","required":false,"in":"query","description":"Filter securities created from this date","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2022-01-01","type":"string"}},{"name":"createdDateTo","required":false,"in":"query","description":"Filter securities created up to this date","schema":{"format":"iso8601 (YYYY-MM-DD)","example":"2022-12-31","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPageDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Securities"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities' -Method GET -Headers $headers\nWrite-Output $response"}]}},"/securities/{securityId}":{"get":{"description":"Reads target security by its ID.","operationId":"Read Security by ID","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"404":{"description":"Security not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Securities"],"x-codeSamples":[{"lang":"cURL","source":"curl --request GET \\\n--url 'https://core.gorila.com.br/securities/1' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1' -Method GET -Headers $headers\nWrite-Output $response"}]},"delete":{"description":"Deletes target security by its ID.","operationId":"Delete Security by ID","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}}],"responses":{"204":{"description":""},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"404":{"description":"Security not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Securities"],"x-codeSamples":[{"lang":"cURL","source":"curl --request DELETE \\\n--url 'https://core.gorila.com.br/securities/1' \\\n--header 'authorization: your_authorization' \\\n"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1' -Method DELETE -Headers $headers\nWrite-Output $response"}]},"patch":{"description":"Update data of a security by its ID.","operationId":"Update Security by ID","parameters":[{"name":"securityId","required":true,"in":"path","description":"Target security unique ID","schema":{"format":"integer","type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityDto"}}}},"400":{"description":"Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"403":{"description":"Access to target portfolio denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorForbiddenDto"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}}},"security":[{"API Key":[]}],"summary":"","tags":["Securities"],"x-codeSamples":[{"lang":"cURL","source":"curl --request PATCH \\\n--url 'https://core.gorila.com.br/securities/1' \\\n--header 'authorization: your_authorization' \\\n--header 'Content-Type: application/json' \\\n--data '{}'"},{"lang":"PowerShell","source":"$headers=@{}\n$headers.Add(\"authorization\", \"your_authorization\")\n$headers.Add(\"Content-Type\", \"application/json\")\n$response = Invoke-WebRequest -Uri 'https://core.gorila.com.br/securities/1' -Method PATCH -Headers $headers -Body '{}'\nWrite-Output $response"}]}}},"info":{"title":"Gorila | Core API","description":"# Introduction\n\nThe purpose of this API is to make all of Gorila's state-of-the-art calculation engine available to our partners in a easy to use but powerful and reliable way.\n\nThis is an RESTFul API which uses predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, verbs and industry best-practices.\n\nFor more information, check our [Documentation](https://gorila.com.br/core/developers).\n\nTo get a sense of what is like to use the API for the first time, check our [Quickstart](https://gorila.com.br/core/docs/quickstart).\n\n# Authentication\n\nGorila's Core API uses API keys to authenticate requests. These will be created, invalidated and managed directly with our costumer success team.\n\nThese keys will grant access to their respective portfolios and will carry wide-ranging privileges. Meaning that their security is of the utmost importance so keep their access and knowledge closely guarded and do not share them publicly.\n\nOur API is hosted at the URL below, and all requests must be made over `https` protocol:\n\n```text\nhttps://core.gorila.com.br\n```\n\nYour API key is a 32 characters string that should be sent at `Authorization` property of HTTP headers, for instance:\n\n```sh\ncurl --request GET \\\n --url https://core.gorila.com.br/portfolios \\\n --header 'Authorization: 7ce547b2afa8457c2d2acfce7fc9e615'\n```\n\nFailures in providing a valid key will result in `Unauthorized Error`:\n\n```json\n{\n  \"code\": 401,\n  \"message\": \"authentication is invalid\"\n}\n```\n\n\n# Pagination\n\nResources that represent collections (e.g. portfolios, transactions, positions) are returned in paginated results.\n\nGorila CORE API utilizes cursor based pagination. Each request to a supported endpoint will include a `next` property within its response, which leads directly to the next page of results.\n\nYou may also specify desired page size through `limit` query parameter.\n\nTherefore it is easy for the consumer to navigate between results, for example:\n\n**First Request**\n\nAcquiring transactions of target portfolio, with a page size of 100 records:\n\n```text\nGET https://core.gorila.com.br/portfolios/:portfolioId/transaction?limit=100\n```\n\n**First Response**\n\n```json\n{\n  \"next\": \"https://core.gorila.com.br/securities?pageToken=580c52161751632af5fdcd14bf520078?limit=100\",\n  \"records\": [\n    ...\n  ]\n}\n```\n\n**Second Request**\n\nSimply `GET` the URL provided at `next`, this should return the next page of results:\n\n```text\nhttps://core.gorila.com.br/portfolios/:portfolioId/transaction?token=580c52161751632af5fdcd14bf520078\n```\n\nWhen there are no more results available to ask, the `next` property will be ommitted. This means there are no more pages to consume.\n\n# Rate Limits\n\nHitting our rate limits will result in HTTP 429 errors. Rate limits are tiered by your account's negotiated volumes.\n","version":"v1","contact":{},"x-logo":{"url":"./assets/logo.png","href":"https://www.gorila.com.br"}},"tags":[{"name":"Benchmarks","description":""},{"name":"Brokers","description":""},{"name":"Security Classifications","description":""},{"name":"Securities","description":""},{"name":"Positions","description":""},{"name":"Drawdown","description":""},{"name":"Investment Profiles","description":""},{"name":"Portfolios","description":""},{"name":"Economic Groups","description":""},{"name":"Economic Groups Drawdown","description":""},{"name":"Invested Amount","description":""},{"name":"Economic Group Invested Amount","description":""},{"name":"Liquidity","description":""},{"name":"Economic Groups Liquidity","description":""},{"name":"Market Values","description":""},{"name":"Net Asset Value","description":""},{"name":"Economic Groups Net Asset Value","description":""},{"name":"Profit & Losses","description":""},{"name":"Economic Groups Profit & Losses","description":""},{"name":"Economic Group Positions Average Price","description":""},{"name":"Economic Groups Positions","description":""},{"name":"Economic Group Positions Internal Rate of Return","description":""},{"name":"Economic Group Positions Market Values","description":""},{"name":"Economic Group Positions Invested Amount","description":""},{"name":"Economic Group Positions Liquidity","description":""},{"name":"Economic Group Positions Profit & Losses","description":""},{"name":"Time-Weighted Return","description":""},{"name":"Economic Group Positions Time-Weighted Return","description":""},{"name":"Economic Group Positions Security Prices","description":""},{"name":"Economic Groups Security Events","description":""},{"name":"Sharpe Ratio","description":""},{"name":"Economic Groups Sharpe Ratio","description":""},{"name":"Transactions","description":""},{"name":"Economic Groups Transactions","description":""},{"name":"Economic Groups Time-Weighted Return","description":""},{"name":"Volatility","description":""},{"name":"Economic Groups Volatility","description":""},{"name":"Issuers","description":""},{"name":"Position Allocation","description":""},{"name":"Average Prices","description":""},{"name":"Dividend Yield","description":""},{"name":"Internal Rate of Return","description":""},{"name":"Position Liquidity","description":""},{"name":"Position Invested Amount","description":""},{"name":"Position Profit & Losses","description":""},{"name":"Position Time-Weighted Return","description":""},{"name":"Position Security Prices","description":""},{"name":"Portfolio Security Events","description":""},{"name":"Portfolio Target Allocation","description":""},{"name":"Security Events","description":""},{"name":"Security KPIs","description":""},{"name":"Price Conversions","description":""},{"name":"Security Prices","description":""}],"servers":[{"url":"https://core.gorila.com.br","description":"Production"}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","in":"header","name":"authorization"}},"schemas":{"BenchmarkDto":{"type":"object","properties":{"id":{"type":"string","description":"Benchmark unique identification","example":"DOW_JONES_IA","minLength":1},"name":{"type":"string","description":"Benchmark name","example":"Dow Jones Industrial Average","minLength":1},"description":{"type":"string","description":"Benchmark description","example":"Stock index that tracks 30 of the largest U.S. companies","minLength":1}},"required":["id","name","description"],"title":"BenchmarkDto"},"BenchmarkPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/BenchmarkDto"}}},"required":["next","records"],"title":"BenchmarkPageDto"},"ErrorBadRequestDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":400},"message":{"type":"string","description":"Error message","example":"request validation failed"},"constraints":{"description":"Failing validation conditions","example":["portfolioId must be a UUID"],"type":"array","items":{"type":"string"}},"errors":{"description":"Failing validation errors","type":"array","items":{"type":"string"}}},"required":["code","message","constraints","errors"],"title":"ErrorBadRequestDto"},"ErrorUnauthorizedDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":401},"message":{"type":"string","description":"Error message","example":"missing authentication"}},"required":["code","message"],"title":"ErrorUnauthorizedDto"},"ErrorForbiddenDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":403},"message":{"type":"string","description":"Error message","example":"unauthorized resource"}},"required":["code","message"],"title":"ErrorForbiddenDto"},"ErrorTooManyRequestsDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":429},"message":{"type":"string","description":"Error message","example":"rate limit exceeded"}},"required":["code","message"],"title":"ErrorTooManyRequestsDto"},"BenchmarkIntervalDto":{"type":"object","properties":{"value":{"type":"number","description":"Profit value of the benchmark at current data point","example":0.009270539999999938,"format":"float"},"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"}},"required":["value","startDate","endDate"],"title":"BenchmarkIntervalDto"},"BenchmarkTimeseriesDto":{"type":"object","properties":{"value":{"type":"number","description":"Profit value of the benchmark at current data point","example":0.009270539999999938,"format":"float"},"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"}},"required":["value","referenceDate"],"title":"BenchmarkTimeseriesDto"},"BenchmarkTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/BenchmarkIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/BenchmarkTimeseriesDto"}}},"required":["interval","timeseries"],"title":"BenchmarkTimeDto"},"BrokerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the broker","example":"91272516000140","minLength":1},"name":{"type":"string","description":"Registered name of the brokerage house","example":"GORILA VALORES MOBILIÁRIOS S.A","minLength":1}},"required":["id","name"],"title":"BrokerDto"},"BrokerPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/BrokerDto"}}},"required":["next","records"],"title":"BrokerPageDto"},"ErrorNotFoundDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":404},"message":{"type":"string","description":"Error message","example":"resource not found"}},"required":["code","message"],"title":"ErrorNotFoundDto"},"DrawdownTimeseriesDto":{"type":"object","properties":{"drawdown":{"type":"number","description":"The drawdown value at the given time point","example":-0.2345,"format":"float"},"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"}},"required":["drawdown","referenceDate"],"title":"DrawdownTimeseriesDto"},"EconomicGroupDrawdownTimeDto":{"type":"object","properties":{"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/DrawdownTimeseriesDto"}}},"required":["timeseries"],"title":"EconomicGroupDrawdownTimeDto"},"EconomicGroupCreateDto":{"type":"object","properties":{"name":{"type":"string","description":"Nickname of the Economic Group","example":"Doe Family Group","minLength":1},"portfolios":{"description":"Array of Portfolios Ids","example":["1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7"],"maxItems":10,"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name","portfolios"],"title":"EconomicGroupCreateDto"},"InvestmentProfilePortfolioDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing an investment profile entity","example":"1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","format":"uuid"},"name":{"type":"string","description":"Name of the investment profile","example":"Conservative Profile","minLength":1}},"required":["id","name"],"title":"InvestmentProfilePortfolioDto"},"PortfolioDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing a portfolio entity","example":"1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","format":"uuid"},"name":{"type":"string","description":"Nickname of the portfolio","example":"John Doe Portfolio","minLength":1},"autoRnC":{"type":"boolean","description":"Enables automatic creation of contributions and redemptions operations","default":false},"createdDate":{"type":"string","description":"Date and time when the portfolio was created","example":"2024-01-01T00:00:00Z","format":"iso8601"},"autoComeCotas":{"type":"boolean","description":"Whether or not automatic come-cotas is enabled","default":false},"status":{"type":"string","description":"Status of the portfolio","example":"COMPLETED","enum":["COMPLETED","PROCESSING","INVALID"]},"alias":{"type":"string","description":"Alias for the portfolio","example":"John's Portfolio","nullable":true},"connected":{"type":"boolean","description":"Indicates if the portfolio is connected from other organization","example":false},"investmentProfile":{"description":"Investment profile associated with the portfolio.","example":{"id":"1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","name":"Conservative Profile"},"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/InvestmentProfilePortfolioDto"}]}},"required":["id","name","autoRnC","createdDate","autoComeCotas","status","connected"],"title":"PortfolioDto"},"EconomicGroupDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing Econ Group entity","example":"1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","format":"uuid"},"name":{"type":"string","description":"Nickname of the Economic Group","example":"Doe Family Group","minLength":1},"status":{"type":"string","description":"Status of the Economic Group","example":"PROCESSING","enum":["COMPLETED","PROCESSING","INVALID"]},"portfolios":{"type":"array","items":{"$ref":"#/components/schemas/PortfolioDto"}}},"required":["id","name","status","portfolios"],"title":"EconomicGroupDto"},"EconomicGroupPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupDto"}}},"required":["next","records"],"title":"EconomicGroupPageDto"},"EconomicGroupUpdateDto":{"type":"object","properties":{"name":{"type":"string","description":"Nickname of the Economic Group","example":"Doe Family Group","minLength":1},"portfolios":{"description":"Array of Portfolios Ids","example":["1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7","1e0c3ede-01e5-4e81-ba6f-a50c9bd39fb7"],"maxItems":10,"type":"array","items":{"type":"string","format":"uuid"}}},"title":"EconomicGroupUpdateDto"},"InvestedAmountIntervalDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"nullable":true,"format":"float"},"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"}},"required":["currency","investedAmount","startDate","endDate"],"title":"InvestedAmountIntervalDto"},"InvestedAmountTimeseriesDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"nullable":true,"format":"float"},"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"}},"required":["currency","investedAmount","referenceDate"],"title":"InvestedAmountTimeseriesDto"},"EconomicGroupInvestedAmountTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/InvestedAmountIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/InvestedAmountTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupInvestedAmountTimeDto"},"LiquidityRangeDto":{"type":"object","properties":{"minDays":{"type":"number","description":"Minimum number of days for the liquidity range","example":0,"nullable":true,"format":"integer"},"maxDays":{"type":"number","description":"Maximum number of days for the liquidity range","example":1,"nullable":true,"format":"integer"},"marketValue":{"type":"number","description":"Aggregated market value of positions within this liquidity range","example":150000,"format":"float"}},"required":["marketValue"],"title":"LiquidityRangeDto"},"EconomicGroupLiquidityDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date used to calculate liquidity","example":"2026-02-03","nullable":true,"format":"iso8601"},"currency":{"type":"string","description":"Currency of the aggregated market values","example":"BRL","minLength":1},"ranges":{"type":"array","items":{"$ref":"#/components/schemas/LiquidityRangeDto"}}},"required":["currency","ranges"],"title":"EconomicGroupLiquidityDto"},"NavIntervalDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"nav":{"type":"number","description":"Net asset value of positions at reference date","example":4567.15,"nullable":true,"format":"float"},"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"}},"required":["currency","nav","startDate","endDate"],"title":"NavIntervalDto"},"NavTimeseriesDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"nav":{"type":"number","description":"Net asset value of positions at reference date","example":4567.15,"nullable":true,"format":"float"},"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"}},"required":["currency","nav","referenceDate"],"title":"NavTimeseriesDto"},"EconomicGroupNavTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/NavIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/NavTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupNavTimeDto"},"PnlIntervalDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"nullable":true,"format":"float"},"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"}},"required":["currency","pnl","startDate","endDate"],"title":"PnlIntervalDto"},"PnlTimeseriesDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"nullable":true,"format":"float"},"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"}},"required":["currency","pnl","referenceDate"],"title":"PnlTimeseriesDto"},"EconomicGroupPnlTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/PnlIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/PnlTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupPnlTimeDto"},"SecurityClassificationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the security classification.","example":"550e8400-e29b-41d4-a716-446655440000","minLength":1},"name":{"type":"string","description":"The name of the security classification. Letters (including accented), numbers, spaces, and special characters are allowed.","example":"Multimercado","pattern":"^[a-zA-Z0-9 !\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~À-ÖØ-öØ-ÿÇç]*$","minLength":1},"level":{"type":"string","description":"The level of the security classification.","example":"CLASSIFICATION_L0","enum":["CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]},"parentId":{"type":"string","description":"The unique identifier of the parent security classification, if any.","example":"550e8400-e29b-41d4-a716-446655440001","nullable":true,"minLength":1}},"required":["id","name","level"],"title":"SecurityClassificationDto"},"SecuritySummaryDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"},"isin":{"type":"string","description":"International Securities Identification Number","example":"BRPETRACNOR9","pattern":"[A-Z]{2}[\\dA-Z]{9}\\d"},"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"},"assetClass":{"type":"string","description":"Highest order of security classification","example":"STOCKS","minLength":1,"enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]},"type":{"type":"string","description":"Gorila's type classification of the position's security","example":"STOCK_LOCAL","minLength":1},"name":{"type":"string","description":"Oficial ticker symbol of the position's security","example":"PETR4","minLength":1},"description":{"type":"string","description":"Longer description for the custom security,useful for the user to better identify and differentiate between them","example":"Apartment located in São Paulo"},"issuer":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","example":"12ABC34501DE35"},"maturityDate":{"type":"string","description":"Date of maturity for the asset","example":"2022-05-16","format":"iso8601"},"dealType":{"type":"string","description":"Type of security indexation"},"index":{"type":"string","description":"Benchmark used as reference"},"yield":{"type":"number","description":"Security return based on dealType and index","format":"float"},"classifications":{"description":"Security classifications","type":"array","items":{"$ref":"#/components/schemas/SecurityClassificationDto"}}},"required":["id","assetClass","type","name"],"title":"SecuritySummaryDto"},"EconomicGroupAveragePriceDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"averagePrice":{"type":"number","description":"Calculated average price for target position","example":54.62,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","currency","averagePrice"],"title":"EconomicGroupAveragePriceDto"},"EconomicGroupAveragePricePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupAveragePriceDto"}}},"required":["next","records"],"title":"EconomicGroupAveragePricePageDto"},"EconomicGroupPositionDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"quantity":{"type":"number","description":"Amount of the position's security","example":32.17,"format":"float"},"state":{"type":"string","description":"State of the position","example":"OPEN","minLength":1,"enum":["OPEN","CLOSED"]},"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"}},"required":["referenceDate","security","broker","quantity","state","portfolioId"],"title":"EconomicGroupPositionDto"},"EconomicGroupPositionPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupPositionDto"}}},"required":["next","records"],"title":"EconomicGroupPositionPageDto"},"EconomicGroupIrrDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"irr":{"type":"number","description":"Calculated IRR for target position","example":54.62,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","irr"],"title":"EconomicGroupIrrDto"},"EconomicGroupIrrPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupIrrDto"}}},"required":["next","records"],"title":"EconomicGroupIrrPageDto"},"EconomicGroupMarketValueDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"marketValue":{"type":"number","description":"Cash equivalent market value of the position's security","example":32.17,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","currency","marketValue"],"title":"EconomicGroupMarketValueDto"},"EconomicGroupMarketValueGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"marketValue":{"type":"number","description":"Cash equivalent market value of the position's security","example":32.17,"format":"float"}},"required":["referenceDate","currency","marketValue"],"title":"EconomicGroupMarketValueGroupDto"},"EconomicGroupMarketValueRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupMarketValueDto"}}},"required":["next","records"],"title":"EconomicGroupMarketValueRecordPageDto"},"EconomicGroupMarketValueGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/EconomicGroupMarketValueGroupDto"}}},"required":["groups"],"title":"EconomicGroupMarketValueGroupPageDto"},"EconomicGroupPositionInvestedAmountDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","currency","investedAmount"],"title":"EconomicGroupPositionInvestedAmountDto"},"EconomicGroupPositionInvestedAmountGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"format":"float"}},"required":["referenceDate","currency","investedAmount"],"title":"EconomicGroupPositionInvestedAmountGroupDto"},"EconomicGroupPositionInvestedAmountRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupPositionInvestedAmountDto"}}},"required":["next","records"],"title":"EconomicGroupPositionInvestedAmountRecordPageDto"},"EconomicGroupPositionInvestedAmountGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/EconomicGroupPositionInvestedAmountGroupDto"}}},"required":["groups"],"title":"EconomicGroupPositionInvestedAmountGroupPageDto"},"EconomicGroupPositionLiquidityDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Reference date used to calculate liquidity","example":"2026-02-03","nullable":true,"format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"daysToLiquidity":{"type":"number","description":"Number of days until the position becomes liquid, null when liquidity is unavailable","example":2,"nullable":true,"format":"integer"}},"required":["portfolioId","security","broker"],"title":"EconomicGroupPositionLiquidityDto"},"EconomicGroupPositionLiquidityPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupPositionLiquidityDto"}}},"required":["next","records"],"title":"EconomicGroupPositionLiquidityPageDto"},"EconomicGroupPositionPnlDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","currency","pnl"],"title":"EconomicGroupPositionPnlDto"},"EconomicGroupPositionPnlGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"format":"float"}},"required":["referenceDate","currency","pnl"],"title":"EconomicGroupPositionPnlGroupDto"},"EconomicGroupPositionPnlRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupPositionPnlDto"}}},"required":["next","records"],"title":"EconomicGroupPositionPnlRecordPageDto"},"EconomicGroupPositionPnlGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/EconomicGroupPositionPnlGroupDto"}}},"required":["groups"],"title":"EconomicGroupPositionPnlGroupPageDto"},"EconomicGroupPositionTwrDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"twr":{"type":"number","description":"Time-weighted rate of return","example":0.23,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","twr"],"title":"EconomicGroupPositionTwrDto"},"EconomicGroupPositionTwrGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"twr":{"type":"number","description":"Time-weighted rate of return","example":0.23,"format":"float"}},"required":["referenceDate","twr"],"title":"EconomicGroupPositionTwrGroupDto"},"EconomicGroupPositionTwrRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupPositionTwrDto"}}},"required":["next","records"],"title":"EconomicGroupPositionTwrRecordPageDto"},"EconomicGroupPositionTwrGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/EconomicGroupPositionTwrGroupDto"}}},"required":["groups"],"title":"EconomicGroupPositionTwrGroupPageDto"},"EconomicGroupSecurityPriceDto":{"type":"object","properties":{"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"},"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"priceClose":{"type":"number","description":"Price close of the position's security","example":32.17,"format":"float"}},"required":["portfolioId","referenceDate","security","broker","currency","priceClose"],"title":"EconomicGroupSecurityPriceDto"},"EconomicGroupSecurityPricePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupSecurityPriceDto"}}},"required":["next","records"],"title":"EconomicGroupSecurityPricePageDto"},"EconomicGroupSecurityEventDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"eventDate":{"type":"string","description":"Ex date of current event","example":"2022-06-01","format":"iso8601"},"eventType":{"type":"string","description":"Gorila classification of security event","example":"CASH_INCOME","minLength":1,"enum":["ASSET_BONUS","ASSET_INPLIT","ASSET_MERGER_AND_ACQUISITION","ASSET_NAME_CHANGE","ASSET_RETURN_OF_CAPITAL","ASSET_SPINOFF","ASSET_SPLIT","ASSET_UNIT_SPLIT","ASSET_OPTION_EXERCISE","CASH_AMORTIZATION","CASH_AMORTIZATION_TOTAL","CASH_AMORTIZATION_TOTAL_EARLY","CASH_AMORTIZATION_UNSCHEDULED","CASH_BONUS","CASH_DIVIDEND","CASH_INCOME","CASH_INCOME_OVERDUE","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL","EXPIRATION","FORWARD_EXPIRATION","RIGHTS_BONUS","RECEIPT_EXCHANGE","SAVINGS_ANNIVERSARY","SELL"]},"paymentDate":{"type":"string","description":"Payment date of current event","example":"2022-06-01","format":"iso8601"},"sourceQuantity":{"type":"number","description":"Quantity of source position before event","example":100,"format":"float"},"receivedSecurity":{"description":"Information of received security","allOf":[{"$ref":"#/components/schemas/SecuritySummaryDto"}]},"receivedQuantity":{"type":"number","description":"Quantity of received asset in event","example":25,"format":"float"},"eventFactor":{"type":"number","description":"Quantity factor for received security","example":0.883,"format":"float"},"unitValue":{"type":"number","description":"Unit value for received security","example":10,"format":"float"},"receivedValue":{"type":"number","description":"Total value for received security","example":8.83,"format":"float"},"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"}},"required":["security","broker","eventDate","eventType","paymentDate","portfolioId"],"title":"EconomicGroupSecurityEventDto"},"EconomicGroupSecurityEventPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/EconomicGroupSecurityEventDto"}}},"required":["next","records"],"title":"EconomicGroupSecurityEventPageDto"},"SharpeRatioIntervalDto":{"type":"object","properties":{"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"},"calculateWindow":{"type":"string","description":"The window used to calculate the Sharpe ratio, as requested","enum":["3M","6M","12M","24M","PER_FREQUENCY"]},"sharpeRatio":{"type":"number","description":"Calculated Sharpe Ratio for the requested period","example":0.15,"nullable":true,"format":"float"}},"required":["startDate","endDate","calculateWindow"],"title":"SharpeRatioIntervalDto"},"SharpeRatioTimeseriesDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"},"calculateWindow":{"type":"string","description":"The window used to calculate the Sharpe ratio, as requested","enum":["3M","6M","12M","24M","PER_FREQUENCY"]},"sharpeRatio":{"type":"number","description":"Calculated Sharpe Ratio for the requested period","example":0.15,"nullable":true,"format":"float"}},"required":["referenceDate","calculateWindow"],"title":"SharpeRatioTimeseriesDto"},"EconomicGroupSharpeRatioTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/SharpeRatioIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/SharpeRatioTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupSharpeRatioTimeDto"},"TransactionRegularFeeDto":{"type":"object","properties":{"brokerageFee":{"type":"number","description":"Brokerage fee","example":4.78,"format":"float"},"exchangeFee":{"type":"number","description":"Exchange fee","example":9.54,"format":"float"}},"title":"TransactionRegularFeeDto"},"EconomicGroupTransactionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"TRANSFER_INITIAL_CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":12.34,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]},"sourceBroker":{"$ref":"#/components/schemas/BrokerDto"},"targetBroker":{"$ref":"#/components/schemas/BrokerDto"},"portfolioId":{"type":"string","description":"Identification of reference Portfolio for given position","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid"}},"required":["portfolioId"],"title":"EconomicGroupTransactionDto"},"EconomicGroupTransactionPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularDto"},{"$ref":"#/components/schemas/TransactionPositionCloseDto"},{"$ref":"#/components/schemas/TransactionComeCotasDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferDto"},{"$ref":"#/components/schemas/TransactionCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentDto"},{"$ref":"#/components/schemas/TransactionTransferCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionTransferInitialCustodySuggestionDto"}]}}},"required":["next","records"],"title":"EconomicGroupTransactionPageDto"},"TwrIntervalDto":{"type":"object","properties":{"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"},"twr":{"type":"number","description":"Calculated TWR for target position","example":0.5462,"nullable":true,"format":"float"}},"required":["startDate","endDate","twr"],"title":"TwrIntervalDto"},"TwrTimeseriesDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"},"twr":{"type":"number","description":"Calculated TWR for target position","example":0.5462,"nullable":true,"format":"float"}},"required":["referenceDate","twr"],"title":"TwrTimeseriesDto"},"EconomicGroupTwrTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/TwrIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/TwrTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupTwrTimeDto"},"VolatilityIntervalDto":{"type":"object","properties":{"startDate":{"type":"string","description":"Start date of interval","example":"2021-01-01","format":"iso8601"},"endDate":{"type":"string","description":"End date of interval","example":"2021-01-01","format":"iso8601"},"calculateWindow":{"type":"string","description":"The window used to calculate the volatility, as requested","example":"12M","enum":["3M","6M","12M","24M","PER_FREQUENCY"]},"volatility":{"type":"number","description":"Calculated volatility for the requested period","example":0.15,"nullable":true,"format":"float"}},"required":["startDate","endDate","calculateWindow"],"title":"VolatilityIntervalDto"},"VolatilityTimeseriesDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date of current data point","example":"2021-01-01","format":"iso8601"},"calculateWindow":{"type":"string","description":"The window used to calculate the volatility, as requested","example":"12M","enum":["3M","6M","12M","24M","PER_FREQUENCY"]},"volatility":{"type":"number","description":"Calculated volatility for the requested period","example":0.15,"nullable":true,"format":"float"}},"required":["referenceDate","calculateWindow"],"title":"VolatilityTimeseriesDto"},"EconomicGroupVolatilityTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/VolatilityIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/VolatilityTimeseriesDto"}}},"required":["interval","timeseries"],"title":"EconomicGroupVolatilityTimeDto"},"InvestmentProfileClassificationDto":{"type":"object","properties":{"id":{"type":"string","description":"ID of the security classification (UUID or symbol, e.g. VARIABLE_INCOME_STOCKS)","example":"VARIABLE_INCOME_STOCKS","minLength":1},"percentage":{"type":"number","description":"Allocation percentage in decimal format (e.g. 0.65 = 65%)","example":0.65,"maximum":1}},"required":["id","percentage"],"title":"InvestmentProfileClassificationDto"},"InvestmentProfileCreateDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the investment profile","example":"Conservador","minLength":3},"thresholdLimits":{"description":"Threshold limits in decimal format (e.g. 0.05 = 5%), each in the range (0, 1] with up to 3 decimal places. The first (smaller) value is the lower bound and the second (larger) value is the upper bound. Defaults to [0.05, 0.15].","default":[0.05,0.15],"maxItems":2,"minItems":2,"type":"array","items":{"type":"number","maximum":1}},"classifications":{"description":"Classification allocations. The sum of all percentages must equal 1.","maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/InvestmentProfileClassificationDto"}}},"required":["name","classifications"],"title":"InvestmentProfileCreateDto"},"InvestmentProfileDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the investment profile","example":"499e88ab-b703-4f94-818e-4476fbb6d11a","format":"uuid"},"name":{"type":"string","description":"Name of the investment profile","example":"Conservador","minLength":1},"thresholdLimits":{"description":"Threshold limits in decimal format (e.g. 0.05 = 5%). First element is lower bound, second is upper bound.","example":[0.05,0.15],"maxItems":2,"minItems":2,"type":"array","items":{"type":"number","format":"float"}},"classifications":{"description":"Classification allocations for the profile","type":"array","items":{"$ref":"#/components/schemas/InvestmentProfileClassificationDto"}}},"required":["id","name","thresholdLimits","classifications"],"title":"InvestmentProfileDto"},"InvestmentProfileSummaryDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the investment profile","example":"499e88ab-b703-4f94-818e-4476fbb6d11a","format":"uuid"},"name":{"type":"string","description":"Name of the investment profile","example":"Conservador","minLength":1},"thresholdLimits":{"description":"Threshold limits in decimal format (e.g. 0.05 = 5%). First element is lower bound, second is upper bound.","example":[0.05,0.15],"maxItems":2,"minItems":2,"type":"array","items":{"type":"number","format":"float"}}},"required":["id","name","thresholdLimits"],"title":"InvestmentProfileSummaryDto"},"InvestmentProfilePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Investment profiles for the current page","type":"array","items":{"$ref":"#/components/schemas/InvestmentProfileSummaryDto"}}},"required":["next","records"],"title":"InvestmentProfilePageDto"},"InvestmentProfileUpdateDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the investment profile","example":"Conservador","minLength":3},"thresholdLimits":{"description":"Threshold limits in decimal format (e.g. 0.05 = 5%), each in the range (0, 1] with up to 3 decimal places. The first (smaller) value is the lower bound and the second (larger) value is the upper bound. Defaults to [0.05, 0.15].","default":[0.05,0.15],"maxItems":2,"minItems":2,"type":"array","items":{"type":"number","maximum":1}},"classifications":{"description":"Classification allocations. The sum of all percentages must equal 1.","maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/InvestmentProfileClassificationDto"}}},"title":"InvestmentProfileUpdateDto"},"IssuerDto":{"type":"object","properties":{"id":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","example":"12ABC34501DE35"},"name":{"type":"string","description":"Registered name of the issuer","example":"GORILA DTVM","minLength":1}},"required":["id","name"],"title":"IssuerDto"},"IssuerPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/IssuerDto"}}},"required":["next","records"],"title":"IssuerPageDto"},"DrawdownTimeDto":{"type":"object","properties":{"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/DrawdownTimeseriesDto"}}},"required":["timeseries"],"title":"DrawdownTimeDto"},"InvestedAmountTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/InvestedAmountIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/InvestedAmountTimeseriesDto"}}},"required":["interval","timeseries"],"title":"InvestedAmountTimeDto"},"LiquidityDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date used to calculate liquidity","example":"2026-02-03","nullable":true,"format":"iso8601"},"currency":{"type":"string","description":"Currency of the aggregated market values","example":"BRL","minLength":1},"ranges":{"type":"array","items":{"$ref":"#/components/schemas/LiquidityRangeDto"}}},"required":["currency","ranges"],"title":"LiquidityDto"},"NavTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/NavIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/NavTimeseriesDto"}}},"required":["interval","timeseries"],"title":"NavTimeDto"},"PnlTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/PnlIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/PnlTimeseriesDto"}}},"required":["interval","timeseries"],"title":"PnlTimeDto"},"PortfolioCreateDto":{"type":"object","properties":{"name":{"type":"string","description":"Nickname of the portfolio","example":"John Doe Portfolio","minLength":1},"autoRnC":{"type":"boolean","description":"Enables automatic creation of contributions and redemptions operations","default":false},"autoComeCotas":{"type":"boolean","description":"Whether or not automatic come-cotas is enabled","default":false}},"required":["name","autoRnC"],"title":"PortfolioCreateDto"},"PortfolioPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PortfolioDto"}}},"required":["next","records"],"title":"PortfolioPageDto"},"PortfolioUpdateDto":{"type":"object","properties":{"name":{"type":"string","description":"Nickname of the portfolio","example":"John Doe Portfolio","minLength":1},"autoComeCotas":{"type":"boolean","description":"Whether or not automatic come-cotas is enabled","default":false},"alias":{"type":"string","description":"Alias for the portfolio within the organization","nullable":true},"investmentProfileId":{"type":"string","description":"Investment profile unique ID. Null removes the investment profile from the portfolio","example":"60259b53-591a-4472-b37e-10c51e238974","nullable":true,"format":"uuid"}},"title":"PortfolioUpdateDto"},"AllocationGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date for the position","example":"2026-03-20","format":"iso8601"},"allocation":{"type":"number","description":"Weight of the position relative to total portfolio exposure (|MV_position| / MV_total)","example":0.45,"format":"float"}},"required":["referenceDate","allocation"],"title":"AllocationGroupDto"},"AllocationItemDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date for the position","example":"2026-03-20","format":"iso8601"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"allocation":{"type":"number","description":"Weight of the position relative to total portfolio exposure (|MV_position| / MV_total)","example":0.45,"format":"float"}},"required":["referenceDate","broker","security","allocation"],"title":"AllocationItemDto"},"AllocationRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/AllocationItemDto"}}},"required":["next","records"],"title":"AllocationRecordPageDto"},"AllocationGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/AllocationGroupDto"}}},"required":["groups"],"title":"AllocationGroupPageDto"},"AveragePriceDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"averagePrice":{"type":"number","description":"Calculated average price for target position","example":54.62,"format":"float"}},"required":["referenceDate","security","broker","currency","averagePrice"],"title":"AveragePriceDto"},"AveragePricePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/AveragePriceDto"}}},"required":["next","records"],"title":"AveragePricePageDto"},"DividendYieldDto":{"type":"object","properties":{"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"dividendYield":{"type":"number","description":"Dividend yield for the position","example":12.17,"format":"float"},"hasOpenPositionAllDays":{"type":"boolean","description":"Indicates if the position has an open position all days","example":true},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"}},"required":["currency","dividendYield","hasOpenPositionAllDays","security"],"title":"DividendYieldDto"},"DividendYieldPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/DividendYieldDto"}}},"required":["next","records"],"title":"DividendYieldPageDto"},"IrrDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"irr":{"type":"number","description":"Calculated IRR for target position","example":54.62,"format":"float"}},"required":["referenceDate","security","broker","irr"],"title":"IrrDto"},"IrrPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/IrrDto"}}},"required":["next","records"],"title":"IrrPageDto"},"LiquidityPositionDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date used to calculate liquidity","example":"2026-02-03","nullable":true,"format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"daysToLiquidity":{"type":"number","description":"Number of days until the position becomes liquid, null when liquidity is unavailable","example":2,"nullable":true,"format":"integer"}},"required":["security","broker"],"title":"LiquidityPositionDto"},"LiquidityPositionPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/LiquidityPositionDto"}}},"required":["next","records"],"title":"LiquidityPositionPageDto"},"MarketValueGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"marketValue":{"type":"number","description":"Cash equivalent market value of the position's security","example":32.17,"format":"float"}},"required":["referenceDate","currency","marketValue"],"title":"MarketValueGroupDto"},"MarketValueDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"marketValue":{"type":"number","description":"Cash equivalent market value of the position's security","example":32.17,"format":"float"}},"required":["referenceDate","security","broker","currency","marketValue"],"title":"MarketValueDto"},"MarketValueRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/MarketValueDto"}}},"required":["next","records"],"title":"MarketValueRecordPageDto"},"MarketValueGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/MarketValueGroupDto"}}},"required":["groups"],"title":"MarketValueGroupPageDto"},"PositionInvestedAmountDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"format":"float"}},"required":["referenceDate","security","broker","currency","investedAmount"],"title":"PositionInvestedAmountDto"},"PositionInvestedAmountRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PositionInvestedAmountDto"}}},"required":["next","records"],"title":"PositionInvestedAmountRecordPageDto"},"PositionInvestedAmountGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/PositionInvestedAmountGroupDto"}}},"required":["groups"],"title":"PositionInvestedAmountGroupPageDto"},"PositionInvestedAmountGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"investedAmount":{"type":"number","description":"Invested amount of positions at reference date","example":4567.15,"format":"float"}},"required":["referenceDate","currency","investedAmount"],"title":"PositionInvestedAmountGroupDto"},"PositionPnlGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"format":"float"}},"required":["referenceDate","currency","pnl"],"title":"PositionPnlGroupDto"},"PositionPnlDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"pnl":{"type":"number","description":"Nominal profit or loss for the position at this date","example":356043.23,"format":"float"}},"required":["referenceDate","security","broker","currency","pnl"],"title":"PositionPnlDto"},"PositionPnlRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PositionPnlDto"}}},"required":["next","records"],"title":"PositionPnlRecordPageDto"},"PositionPnlGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/PositionPnlGroupDto"}}},"required":["groups"],"title":"PositionPnlGroupPageDto"},"PositionTwrGroupDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"twr":{"type":"number","description":"Time-weighted rate of return","example":0.23,"format":"float"}},"required":["referenceDate","twr"],"title":"PositionTwrGroupDto"},"PositionTwrDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"twr":{"type":"number","description":"Time-weighted rate of return","example":0.23,"format":"float"}},"required":["referenceDate","security","broker","twr"],"title":"PositionTwrDto"},"PositionTwrRecordPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PositionTwrDto"}}},"required":["next","records"],"title":"PositionTwrRecordPageDto"},"PositionTwrGroupPageDto":{"type":"object","properties":{"groups":{"type":"object","description":"Dictionary of resulting groups","additionalProperties":{"$ref":"#/components/schemas/PositionTwrGroupDto"}}},"required":["groups"],"title":"PositionTwrGroupPageDto"},"PositionDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"quantity":{"type":"number","description":"Amount of the position's security","example":32.17,"format":"float"},"state":{"type":"string","description":"State of the position","example":"OPEN","minLength":1,"enum":["OPEN","CLOSED"]}},"required":["referenceDate","security","broker","quantity","state"],"title":"PositionDto"},"PositionPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PositionDto"}}},"required":["next","records"],"title":"PositionPageDto"},"PositionSecurityPriceDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the position","example":"2022-04-04","format":"iso8601"},"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"priceClose":{"type":"number","description":"Price close of the position's security","example":32.17,"format":"float"}},"required":["referenceDate","security","broker","currency","priceClose"],"title":"PositionSecurityPriceDto"},"PositionSecurityPricePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PositionSecurityPriceDto"}}},"required":["next","records"],"title":"PositionSecurityPricePageDto"},"PortfolioSecurityEventDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"currency":{"type":"string","description":"Currency symbol of the position's security","example":"BRL","minLength":1},"eventDate":{"type":"string","description":"Ex date of current event","example":"2022-06-01","format":"iso8601"},"eventType":{"type":"string","description":"Gorila classification of security event","example":"CASH_INCOME","minLength":1,"enum":["ASSET_BONUS","ASSET_INPLIT","ASSET_MERGER_AND_ACQUISITION","ASSET_NAME_CHANGE","ASSET_RETURN_OF_CAPITAL","ASSET_SPINOFF","ASSET_SPLIT","ASSET_UNIT_SPLIT","ASSET_OPTION_EXERCISE","CASH_AMORTIZATION","CASH_AMORTIZATION_TOTAL","CASH_AMORTIZATION_TOTAL_EARLY","CASH_AMORTIZATION_UNSCHEDULED","CASH_BONUS","CASH_DIVIDEND","CASH_INCOME","CASH_INCOME_OVERDUE","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL","EXPIRATION","FORWARD_EXPIRATION","RIGHTS_BONUS","RECEIPT_EXCHANGE","SAVINGS_ANNIVERSARY","SELL"]},"paymentDate":{"type":"string","description":"Payment date of current event","example":"2022-06-01","format":"iso8601"},"sourceQuantity":{"type":"number","description":"Quantity of source position before event","example":100,"format":"float"},"receivedSecurity":{"description":"Information of received security","allOf":[{"$ref":"#/components/schemas/SecuritySummaryDto"}]},"receivedQuantity":{"type":"number","description":"Quantity of received asset in event","example":25,"format":"float"},"eventFactor":{"type":"number","description":"Quantity factor for received security","example":0.883,"format":"float"},"unitValue":{"type":"number","description":"Unit value for received security","example":10,"format":"float"},"receivedValue":{"type":"number","description":"Total value for received security","example":8.83,"format":"float"}},"required":["security","broker","eventDate","eventType","paymentDate"],"title":"PortfolioSecurityEventDto"},"PortfolioSecurityEventPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/PortfolioSecurityEventDto"}}},"required":["next","records"],"title":"PortfolioSecurityEventPageDto"},"SharpeRatioTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/SharpeRatioIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/SharpeRatioTimeseriesDto"}}},"required":["interval","timeseries"],"title":"SharpeRatioTimeDto"},"TargetAllocationInvestmentProfileDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier","example":"bade6a6b-f04e-4304-842c-b1254244a898","format":"uuid"},"name":{"type":"string","description":"The name of the investment profile. Letters (including accented), numbers, spaces, and special characters are allowed.","example":"Conservative Profile","pattern":"^[a-zA-Z0-9 !\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~À-ÖØ-öØ-ÿÇç]*$","minLength":1},"thresholdLimits":{"description":"Threshold limits in decimal format (e.g. 0.05 = 5%) [lowerThreshold, upperThreshold]","example":[0.05,0.15],"maxItems":2,"minItems":2,"type":"array","items":{"type":"number","format":"float"}}},"required":["id","name","thresholdLimits"],"title":"TargetAllocationInvestmentProfileDto"},"TargetAllocationClassificationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the security classification.","example":"550e8400-e29b-41d4-a716-446655440000","minLength":1},"name":{"type":"string","description":"The name of the security classification. Letters (including accented), numbers, spaces, and special characters are allowed.","example":"Multimercado","pattern":"^[a-zA-Z0-9 !\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~À-ÖØ-öØ-ÿÇç]*$","minLength":1},"level":{"type":"string","description":"The level of the security classification.","example":"CLASSIFICATION_L0","enum":["CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]},"target":{"type":"number","description":"Target allocation percentage (0-1)","example":0.25,"maximum":1,"minimum":0,"format":"float"},"allocation":{"type":"number","description":"Actual allocation percentage (0-1)","example":0.13,"maximum":1,"minimum":0,"format":"float"},"differential":{"type":"number","description":"Differential between target and actual allocation (positive = underallocated, negative = overallocated)","example":0.12,"format":"float"}},"required":["id","name","level","target","allocation","differential"],"title":"TargetAllocationClassificationDto"},"TargetAllocationDto":{"type":"object","properties":{"investmentProfile":{"description":"The investment profile associated with the portfolio, or null if none is configured.","allOf":[{"$ref":"#/components/schemas/TargetAllocationInvestmentProfileDto"}]},"referenceDate":{"type":"string","description":"Reference date from the KPI response. Null when there is no KPI data.","example":"2024-06-30","format":"iso8601"},"classifications":{"description":"List of classifications with target vs actual allocation details.","type":"array","items":{"$ref":"#/components/schemas/TargetAllocationClassificationDto"}}},"required":["classifications"],"title":"TargetAllocationDto"},"SecurityIdsMutuallyExclusiveCreateDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"},"isin":{"type":"string","description":"International Securities Identification Number","example":"US9311421039","pattern":"[A-Z]{2}[\\dA-Z]{9}\\d"},"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"}},"title":"SecurityIdsMutuallyExclusiveCreateDto"},"TransactionRegularCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["transactDate","quantity","type","brokerId","security","side"],"title":"TransactionRegularCreateDto"},"TransactionPositionCloseCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["transactDate","type","brokerId","security"],"title":"TransactionPositionCloseCreateDto"},"TransactionComeCotasCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]}},"required":["transactDate","quantity","type","brokerId","security"],"title":"TransactionComeCotasCreateDto"},"TransactionOptionExerciseCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]}},"required":["transactDate","quantity","type","brokerId","security"],"title":"TransactionOptionExerciseCreateDto"},"TransactionSubscriptionExerciseCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]}},"required":["transactDate","quantity","type","brokerId","security"],"title":"TransactionSubscriptionExerciseCreateDto"},"TransactionCustodyTransferCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":37.46,"format":"float"},"sourceBrokerId":{"type":"string","description":"National identifier of the custodian institution","example":"91272516000140"},"targetBrokerId":{"type":"string","description":"National identifier of the custodian institution","example":"91272516000140"}},"required":["transactDate","quantity","type","security"],"title":"TransactionCustodyTransferCreateDto"},"TransactionInitialCustodyAdjustmentCreateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","INITIAL_CUSTODY_ADJUSTMENT","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","POSITION_CLOSE"]},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["transactDate","quantity","type","brokerId","security","side"],"title":"TransactionInitialCustodyAdjustmentCreateDto"},"TransactionRegularDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"REGULAR"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status","side","price","fees"],"title":"TransactionRegularDto"},"TransactionPositionCloseDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"REGULAR"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","status","price","fees"],"title":"TransactionPositionCloseDto"},"TransactionComeCotasDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"COME_COTAS"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status"],"title":"TransactionComeCotasDto"},"TransactionOptionExerciseDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"OPTION_EXERCISE"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status"],"title":"TransactionOptionExerciseDto"},"TransactionSubscriptionExerciseDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"SUBSCRIPTION_EXERCISE"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status"],"title":"TransactionSubscriptionExerciseDto"},"TransactionCustodyTransferDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"CUSTODY_TRANSFER"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"sourceBroker":{"$ref":"#/components/schemas/BrokerDto"},"targetBroker":{"$ref":"#/components/schemas/BrokerDto"},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":12.34,"format":"float"}},"required":["security","id","type","transactDate","createdDate","updatedDate","quantity","status","sourceBroker","targetBroker","price"],"title":"TransactionCustodyTransferDto"},"TransactionCustodySuggestionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status","side","price","fees"],"title":"TransactionCustodySuggestionDto"},"TransactionInitialCustodySuggestionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"INITIAL_CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status","side","price","fees"],"title":"TransactionInitialCustodySuggestionDto"},"TransactionInitialCustodyAdjustmentDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"INITIAL_CUSTODY_ADJUSTMENT"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]}},"required":["security","broker","id","type","transactDate","createdDate","updatedDate","quantity","status","side","price","fees"],"title":"TransactionInitialCustodyAdjustmentDto"},"TransactionTransferCustodySuggestionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"TRANSFER_CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"sourceBroker":{"$ref":"#/components/schemas/BrokerDto"},"targetBroker":{"$ref":"#/components/schemas/BrokerDto"},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":12.34,"format":"float"}},"required":["security","id","type","transactDate","createdDate","updatedDate","quantity","status","sourceBroker","targetBroker","price"],"title":"TransactionTransferCustodySuggestionDto"},"TransactionTransferInitialCustodySuggestionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"TRANSFER_INITIAL_CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"sourceBroker":{"$ref":"#/components/schemas/BrokerDto"},"targetBroker":{"$ref":"#/components/schemas/BrokerDto"},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":12.34,"format":"float"}},"required":["security","id","type","transactDate","createdDate","updatedDate","quantity","status","sourceBroker","targetBroker","price"],"title":"TransactionTransferInitialCustodySuggestionDto"},"TransactionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"broker":{"$ref":"#/components/schemas/BrokerDto"},"id":{"type":"string","description":"Unique ID representing a transaction entity","example":"260f7bbb-71a3-4e9d-8d44-8f0c951880b6","format":"uuid"},"type":{"type":"string","description":"Transaction type being created","minLength":1,"enum":["REGULAR","COME_COTAS","CUSTODY_TRANSFER","OPTION_EXERCISE","SUBSCRIPTION_EXERCISE","CUSTODY_SUGGESTION","INITIAL_CUSTODY_SUGGESTION","INITIAL_CUSTODY_ADJUSTMENT","TRANSFER_CUSTODY_SUGGESTION","TRANSFER_INITIAL_CUSTODY_SUGGESTION","POSITION_CLOSE"],"example":"TRANSFER_INITIAL_CUSTODY_SUGGESTION"},"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"createdDate":{"type":"string","description":"Creation date of the transaction","example":"2022-02-02","format":"iso8601"},"updatedDate":{"type":"string","description":"Last updated date of the transaction","example":"2022-03-03","format":"iso8601"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"status":{"type":"string","minLength":1,"enum":["INVALID","PROCESSING","COMPLETED"]},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Average price of the position at the moment of the transfer","example":12.34,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]},"sourceBroker":{"$ref":"#/components/schemas/BrokerDto"},"targetBroker":{"$ref":"#/components/schemas/BrokerDto"}},"title":"TransactionDto"},"TransactionConflictDto":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","format":"integer","example":409},"message":{"type":"string","description":"Error message","example":"idempotency key already used"}},"required":["code","message"],"title":"TransactionConflictDto"},"TransactionPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TransactionRegularDto"},{"$ref":"#/components/schemas/TransactionPositionCloseDto"},{"$ref":"#/components/schemas/TransactionComeCotasDto"},{"$ref":"#/components/schemas/TransactionOptionExerciseDto"},{"$ref":"#/components/schemas/TransactionSubscriptionExerciseDto"},{"$ref":"#/components/schemas/TransactionCustodyTransferDto"},{"$ref":"#/components/schemas/TransactionCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionInitialCustodyAdjustmentDto"},{"$ref":"#/components/schemas/TransactionTransferCustodySuggestionDto"},{"$ref":"#/components/schemas/TransactionTransferInitialCustodySuggestionDto"}]}}},"required":["next","records"],"title":"TransactionPageDto"},"TransactionUpdateDto":{"type":"object","properties":{"transactDate":{"type":"string","description":"Execution date of the transaction","example":"2022-01-01","format":"iso8601 (YYYY-MM-DD)"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":1000,"minimum":0,"format":"float"},"brokerId":{"type":"string","description":"National identifier of the custodian institution","example":"10721160000183"},"side":{"type":"string","description":"Direction of the transaction","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"number","description":"Price of the negotiated security","example":37.46,"format":"float"},"exchangeRate":{"type":"number","description":"Foreign exchange rate associated to the transaction used for securities negotiated in a currency other than BRL","example":5.41,"format":"float"},"fees":{"description":"List of associated fees","allOf":[{"$ref":"#/components/schemas/TransactionRegularFeeDto"}]},"sourceBrokerId":{"type":"string","description":"National identifier of the custodian institution","example":"91272516000140"},"targetBrokerId":{"type":"string","description":"National identifier of the custodian institution","example":"91272516000140"}},"title":"TransactionUpdateDto"},"TwrTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/TwrIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/TwrTimeseriesDto"}}},"required":["interval","timeseries"],"title":"TwrTimeDto"},"VolatilityTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/VolatilityIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/VolatilityTimeseriesDto"}}},"required":["interval","timeseries"],"title":"VolatilityTimeDto"},"SecurityEventTypeDto":{"type":"object","properties":{"type":{"type":"string","description":"Security Event Type unique identification","example":"ASSET_BONUS","minLength":1,"enum":["ASSET_BONUS","ASSET_INPLIT","ASSET_MERGER_AND_ACQUISITION","ASSET_NAME_CHANGE","ASSET_RETURN_OF_CAPITAL","ASSET_SPINOFF","ASSET_SPLIT","ASSET_UNIT_SPLIT","ASSET_OPTION_EXERCISE","CASH_AMORTIZATION","CASH_AMORTIZATION_TOTAL","CASH_AMORTIZATION_TOTAL_EARLY","CASH_AMORTIZATION_UNSCHEDULED","CASH_BONUS","CASH_DIVIDEND","CASH_INCOME","CASH_INCOME_OVERDUE","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL","EXPIRATION","FORWARD_EXPIRATION","RIGHTS_BONUS","RECEIPT_EXCHANGE","SAVINGS_ANNIVERSARY","SELL"]},"name":{"type":"string","description":"Security Event Type name","example":"BONIFICAÇÃO EM ATIVOS","minLength":1},"description":{"type":"string","description":"Security Event Type description","example":"Código Identificador que representa os eventos de BONIFICAÇÃO EM ATIVOS pagos em ações. EFEITO NA POSIÇÃO: A mudança na posição incide 2 dias úteis ( em linha com ciclo de liquidação de ações ) após a data Ex.  EFEITO NA RENTABILIDADE: O preço médio da posição antes da ocorrência da bonificação é ajustada para também considerar a transação de bonificação usando o preço divulgado em edital correspondente - Mas o ajuste não implica em lançamento no caixa. EFEITO NO CAIXA: Não afeta o caixa. TIPOS DE ATIVOS: Incide principalmente sobre ativos renda variável.","minLength":1}},"required":["type","name","description"],"title":"SecurityEventTypeDto"},"SecurityEventTypePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/SecurityEventTypeDto"}}},"required":["next","records"],"title":"SecurityEventTypePageDto"},"SecurityClassificationCreateBaseDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the security classification. Letters (including accented), numbers, spaces, and special characters are allowed.","example":"Multimercado","pattern":"^[a-zA-Z0-9 !\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~À-ÖØ-öØ-ÿÇç]*$","minLength":1},"level":{"type":"string","description":"The level of the security classification.","example":"CLASSIFICATION_L0","enum":["CLASSIFICATION_L0","CLASSIFICATION_L1","CLASSIFICATION_L2","CLASSIFICATION_L3"]},"parentId":{"type":"string","description":"The unique identifier of the parent security classification, if any.","example":"550e8400-e29b-41d4-a716-446655440001","nullable":true,"minLength":1}},"required":["name","level"],"title":"SecurityClassificationCreateBaseDto"},"SecurityClassificationsPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/SecurityClassificationDto"}}},"required":["next","records"],"title":"SecurityClassificationsPageDto"},"SecurityClassificationUpdateDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the security classification. Letters (including accented), numbers, spaces, and special characters are allowed.","example":"Multimercado","pattern":"^[a-zA-Z0-9 !\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~À-ÖØ-öØ-ÿÇç]*$","minLength":1}},"required":["name"],"title":"SecurityClassificationUpdateDto"},"SecurityExpirationEventCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of the security event","example":"EXPIRATION","enum":["EXPIRATION","CASH_AMORTIZATION","CASH_AMORTIZATION_UNSCHEDULED","CASH_DIVIDEND","CASH_INCOME","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL"]},"referenceDate":{"type":"string","description":"Reference date of the security event","example":"2024-01-31","format":"iso8601 (YYYY-MM-DD)"},"paymentDate":{"type":"string","description":"Payment date of the security event","example":"2024-02-05","format":"iso8601 (YYYY-MM-DD)"},"settlementPrice":{"type":"number","description":"Settlement price of the expired security","example":100,"format":"float"}},"required":["type","referenceDate","paymentDate","settlementPrice"],"title":"SecurityExpirationEventCreateDto"},"SecurityCashEventCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of the security event","example":"EXPIRATION","enum":["EXPIRATION","CASH_AMORTIZATION","CASH_AMORTIZATION_UNSCHEDULED","CASH_DIVIDEND","CASH_INCOME","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL"]},"referenceDate":{"type":"string","description":"Reference date of the security event","example":"2024-01-31","format":"iso8601 (YYYY-MM-DD)"},"paymentDate":{"type":"string","description":"Payment date of the security event","example":"2024-02-05","format":"iso8601 (YYYY-MM-DD)"},"unitValue":{"type":"number","description":"Unit value of the cash event","example":2.5,"format":"float"}},"required":["type","referenceDate","paymentDate","unitValue"],"title":"SecurityCashEventCreateDto"},"SecurityEventDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique identifier of the security event","example":12345,"format":"integer"},"type":{"type":"string","description":"Type of the security event","example":"EXPIRATION","enum":["EXPIRATION","CASH_AMORTIZATION","CASH_AMORTIZATION_UNSCHEDULED","CASH_DIVIDEND","CASH_INCOME","CASH_INTEREST","CASH_JSCP","CASH_PREMIUM","CASH_RETURN_OF_CAPITAL"]},"referenceDate":{"type":"string","description":"Reference date of the security event","example":"2024-01-31","format":"iso8601 (YYYY-MM-DD)"},"paymentDate":{"type":"string","description":"Payment date of the security event","example":"2024-02-05","format":"iso8601 (YYYY-MM-DD)"},"settlementPrice":{"type":"number","description":"Settlement price of the expired security","example":100,"format":"float"},"unitValue":{"type":"number","description":"Unit value of the cash event","example":2.5,"format":"float"}},"title":"SecurityEventDto"},"SecurityEventPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/SecurityEventDto"}}},"required":["next","records"],"title":"SecurityEventPageDto"},"SecurityEventUpdateDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Reference date of the security event","example":"2024-01-31","format":"iso8601 (YYYY-MM-DD)"},"paymentDate":{"type":"string","description":"Payment date of the security event","example":"2024-02-05","format":"iso8601 (YYYY-MM-DD)"},"settlementPrice":{"type":"number","description":"Settlement price of the expired security","example":100,"minimum":0,"format":"float"},"unitValue":{"type":"number","description":"Unit value of the cash event","example":2.5}},"title":"SecurityEventUpdateDto"},"SecurityDrawdownTimeDto":{"type":"object","properties":{"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/DrawdownTimeseriesDto"}}},"required":["timeseries"],"title":"SecurityDrawdownTimeDto"},"SecurityTwrDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/TwrIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/TwrTimeseriesDto"}}},"required":["interval","timeseries"],"title":"SecurityTwrDto"},"SecurityVolatilityTimeDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/VolatilityIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/VolatilityTimeseriesDto"}}},"required":["interval","timeseries"],"title":"SecurityVolatilityTimeDto"},"SecuritySharpeRatioDto":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/SharpeRatioIntervalDto"},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/SharpeRatioTimeseriesDto"}}},"required":["interval","timeseries"],"title":"SecuritySharpeRatioDto"},"PriceConversionCreateDto":{"type":"object","properties":{"security":{"description":"Security identification","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"},{"$ref":"#/components/schemas/SecurityCnpjCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityIdsMutuallyExclusiveCreateDto"}]},"date":{"type":"string","description":"Reference date of the conversion","example":"2023-06-23","format":"iso8601 (YYYY-MM-DD)"},"notional":{"type":"number","description":"Face value of the negotiated security","example":100,"format":"float"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":10,"format":"float"},"multiplier":{"type":"number","description":"Desired multiplier. If target is 110%, ratio should be 1.1","example":2,"format":"float"},"spread":{"type":"number","description":"Desired spread. If target is -5%, spread should be -0.05","example":1,"format":"float"}},"required":["security","date"],"title":"PriceConversionCreateDto"},"PriceConversionDto":{"type":"object","properties":{"security":{"$ref":"#/components/schemas/SecuritySummaryDto"},"date":{"type":"string","description":"Reference date of the conversion","example":"2023-06-23","format":"iso8601"},"price":{"type":"number","description":"Price of the negotiated security","example":1363.34,"format":"float"},"quantity":{"type":"number","description":"Amount of the negotiated security","example":10,"format":"float"}},"required":["security","date","price","quantity"],"title":"PriceConversionDto"},"SecurityTimeSeriesPricesDto":{"type":"object","properties":{"price":{"type":"number","description":"Price of the security","example":10.5,"format":"float"},"referenceDate":{"type":"string","description":"Date of the price","example":"2022-05-16","format":"iso8601"}},"required":["price","referenceDate"],"title":"SecurityTimeSeriesPricesDto"},"SecurityTimeSeriesPricesPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/SecurityTimeSeriesPricesDto"}}},"required":["next","records"],"title":"SecurityTimeSeriesPricesPageDto"},"SecurityPriceItemUpsertDto":{"type":"object","properties":{"referenceDate":{"type":"string","description":"Date of reference for the price","example":"2022-04-04","format":"iso8601 (YYYY-MM-DD)"},"price":{"type":"number","description":"Price of the security","example":100,"minimum":0,"format":"float"}},"required":["referenceDate","price"],"title":"SecurityPriceItemUpsertDto"},"SecurityPriceUpsertDto":{"type":"object","properties":{"prices":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/SecurityPriceItemUpsertDto"}}},"required":["prices"],"title":"SecurityPriceUpsertDto"},"SecurityIdCreateDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"}},"required":["id"],"title":"SecurityIdCreateDto"},"SecurityIsinCreateDto":{"type":"object","properties":{"isin":{"type":"string","description":"International Securities Identification Number","example":"US9311421039","pattern":"[A-Z]{2}[\\dA-Z]{9}\\d"}},"required":["isin"],"title":"SecurityIsinCreateDto"},"SecurityCnpjCreateDto":{"type":"object","properties":{"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"}},"required":["cnpj"],"title":"SecurityCnpjCreateDto"},"SecurityForwardStockUnderlyingSecurityDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"},"isin":{"type":"string","description":"International Securities Identification Number","example":"US9311421039","pattern":"[A-Z]{2}[\\dA-Z]{9}\\d"}},"title":"SecurityForwardStockUnderlyingSecurityDto"},"SecurityForwardStockCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"initialDate":{"type":"string","description":"Security initial date","deprecated":true,"format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","format":"iso8601 (YYYY-MM-DD)"},"underlyingSecurity":{"description":"Identification of underlying security","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityForwardStockUnderlyingSecurityDto"}]}},"required":["type","maturityDate","underlyingSecurity"],"title":"SecurityForwardStockCreateDto"},"SecurityForwardFiiCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"initialDate":{"type":"string","description":"Security initial date","deprecated":true,"format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","format":"iso8601 (YYYY-MM-DD)"},"underlyingSecurity":{"description":"Identification of underlying security","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityForwardStockUnderlyingSecurityDto"}]}},"required":["type","maturityDate","underlyingSecurity"],"title":"SecurityForwardFiiCreateDto"},"SecurityForwardBdrCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"initialDate":{"type":"string","description":"Security initial date","deprecated":true,"format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","format":"iso8601 (YYYY-MM-DD)"},"underlyingSecurity":{"description":"Identification of underlying security","anyOf":[{"$ref":"#/components/schemas/SecurityIdCreateDto"},{"$ref":"#/components/schemas/SecurityIsinCreateDto"}],"allOf":[{"$ref":"#/components/schemas/SecurityForwardStockUnderlyingSecurityDto"}]}},"required":["type","maturityDate","underlyingSecurity"],"title":"SecurityForwardBdrCreateDto"},"SecurityFixRateBankingBondCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"bankingBondType":{"type":"string","description":"Security banking bond type","example":"CDB","enum":["CDB","LCI","LCA","LC","LF","P2B_LENDING","LIG","LFS","LFSN","RDB","RDC","DPGE","REPO","LCD"]},"initialDate":{"type":"string","description":"Security initial date","format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","format":"iso8601 (YYYY-MM-DD)"},"issuerId":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","example":"12ABC34501DE35"},"issuanceFaceValue":{"type":"number","description":"Face value price at emission","example":100,"format":"float"},"interestPaymentPeriod":{"type":"string","description":"Bond payment frequency","example":"EVERY_3_MONTHS","default":"BULLET","enum":["BULLET","MONTHLY","EVERY_2_MONTHS","EVERY_3_MONTHS","EVERY_4_MONTHS","EVERY_6_MONTHS","YEARLY"]},"yield":{"type":"number","description":"Fixed rate yield","example":0.06,"format":"float"}},"required":["type","bankingBondType","initialDate","maturityDate","issuerId","yield"],"title":"SecurityFixRateBankingBondCreateDto"},"SecurityFloatingRateScalingCreateDto":{"type":"object","properties":{"date":{"type":"string","description":"Date when the multiplier change takes effect","example":"2023-01-01","format":"iso8601 (YYYY-MM-DD)"},"multiplier":{"type":"number","description":"It represents the change in multiplier relative to the benchmark on the specified date","example":1.1,"format":"float"}},"required":["date","multiplier"],"title":"SecurityFloatingRateScalingCreateDto"},"SecurityFloatingRateBankingBondCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"bankingBondType":{"type":"string","description":"Security banking bond type","example":"CDB","enum":["CDB","LCI","LCA","LC","LF","P2B_LENDING","LIG","LFS","LFSN","RDB","RDC","DPGE","REPO","LCD"]},"initialDate":{"type":"string","description":"Security initial date","format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","format":"iso8601 (YYYY-MM-DD)"},"issuerId":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","example":"12ABC34501DE35"},"issuanceFaceValue":{"type":"number","description":"Face value price at emission","example":100,"format":"float"},"interestPaymentPeriod":{"type":"string","description":"Bond payment frequency","example":"EVERY_3_MONTHS","default":"BULLET","enum":["BULLET","MONTHLY","EVERY_2_MONTHS","EVERY_3_MONTHS","EVERY_4_MONTHS","EVERY_6_MONTHS","YEARLY"]},"index":{"type":"string","description":"Floating rate index","example":"CDI","enum":["CDI","IPCA","IGPM","SELIC"]},"multiplier":{"type":"number","description":"Floating rate multiplier","example":1.06,"format":"float"},"spread":{"type":"number","description":"Floating rate spread","example":0.02,"format":"float"},"scaleType":{"type":"string","description":"Floating rate scale type","example":"RETROACTIVE","default":"NONE","enum":["NONE","INCREMENTAL","RETROACTIVE"]},"scaling":{"description":"Floating rate scaling over time","maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SecurityFloatingRateScalingCreateDto"}}},"required":["type","bankingBondType","initialDate","maturityDate","issuerId","index"],"title":"SecurityFloatingRateBankingBondCreateDto"},"SecurityCustomCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"initialDate":{"type":"string","description":"Security initial date","example":"2022-04-04","format":"iso8601 (YYYY-MM-DD)"},"maturityDate":{"type":"string","description":"Security maturity date","example":"2050-04-04","format":"iso8601 (YYYY-MM-DD)"},"taxIncentivized":{"type":"boolean","description":"Indicates whether the security has tax incentives.","example":true,"default":false},"assetClass":{"type":"string","description":"Highest order of security classification","example":"FIXED_INCOME","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]},"name":{"type":"string","description":"Name identifying the custom security","example":"Apartment","maxLength":128,"minLength":1},"description":{"type":"string","description":"Longer description for the custom security,useful for the user to better identify and differentiate between them","example":"Apartment located in São Paulo","maxLength":255,"minLength":1},"classificationId":{"type":"string","description":"Gorila internal ID of the security classification","example":"TANGIBLE_GENERIC","minLength":1},"daysToSettlement":{"type":"number","description":"Number of days to settlement","example":2,"minimum":0,"format":"float"}},"required":["type","initialDate","assetClass","name","description"],"title":"SecurityCustomCreateDto"},"SecurityInvestmentClubCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"},"initialDate":{"type":"string","description":"Security initial date","example":"2022-04-04","format":"iso8601 (YYYY-MM-DD)"},"assetClass":{"type":"string","description":"Highest order of security classification","example":"FIXED_INCOME","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]},"name":{"type":"string","description":"Name identifying the investment club security","example":"Gorila's investment club","minLength":1},"description":{"type":"string","description":"Longer description for the investment club security,useful for the user to better identify and differentiate between them","example":"Gorila's investment club is composed of a diversified portfolioof variable and fixed income securities.","minLength":1}},"required":["type","initialDate","assetClass","name","description"],"title":"SecurityInvestmentClubCreateDto"},"SecurityManagedFundCreateDto":{"type":"object","properties":{"type":{"type":"string","description":"Classification of security being created","enum":["FIXED_RATE_BANKING_BOND","FLOATING_RATE_BANKING_BOND","FORWARD_STOCK","FORWARD_FII","FORWARD_BDR","CUSTOM","INVESTMENT_CLUB","MANAGED_FUND"]},"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"},"initialDate":{"type":"string","description":"Security initial date","example":"2022-04-04","format":"iso8601 (YYYY-MM-DD)"},"assetClass":{"type":"string","description":"Highest order of security classification","example":"FIXED_INCOME","enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]},"name":{"type":"string","description":"Name identifying the investment club security","example":"Gorila's investment club","minLength":1},"description":{"type":"string","description":"Longer description for the investment club security,useful for the user to better identify and differentiate between them","example":"Gorila's investment club is composed of a diversified portfolioof variable and fixed income securities.","minLength":1}},"required":["type","initialDate","assetClass","name","description"],"title":"SecurityManagedFundCreateDto"},"SecurityIdDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"}},"required":["id"],"title":"SecurityIdDto"},"SecurityFloatingRateScalingDto":{"type":"object","properties":{"date":{"type":"string","description":"Date when the multiplier change takes effect","example":"2023-01-01","format":"iso8601"},"multiplier":{"type":"number","description":"It represents the change in multiplier relative to the benchmark on the specified date","example":1.1,"format":"float"}},"required":["date","multiplier"],"title":"SecurityFloatingRateScalingDto"},"SecurityDto":{"type":"object","properties":{"id":{"type":"number","description":"Gorila's internal identification of the Security","example":1651,"format":"integer"},"isin":{"type":"string","description":"International Securities Identification Number","example":"BRPETRACNOR9","pattern":"[A-Z]{2}[\\dA-Z]{9}\\d"},"cnpj":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies local mutual funds","example":"12ABC34501DE35"},"assetClass":{"type":"string","description":"Highest order of security classification","example":"STOCKS","minLength":1,"enum":["CASH","CURRENCY","FIXED_INCOME","MULTIMARKET","OFFSHORE","STOCKS","TANGIBLE"]},"type":{"type":"string","description":"Gorila's type classification of the position's security","example":"STOCK_LOCAL","minLength":1},"name":{"type":"string","description":"Oficial ticker symbol of the position's security","example":"PETR4","minLength":1},"description":{"type":"string","description":"Longer description for the custom security,useful for the user to better identify and differentiate between them","example":"Apartment located in São Paulo"},"issuer":{"type":"string","description":"Brazilian tax id (CNPJ) which uniquely identifies the issuer","example":"12ABC34501DE35"},"issueDate":{"type":"string","description":"Date of issue for the asset","example":"2022-05-16","format":"iso8601"},"maturityDate":{"type":"string","description":"Date of maturity for the asset","example":"2022-05-16","format":"iso8601"},"taxIncentivized":{"type":"boolean","description":"Indicates whether the security has tax incentives.","example":true},"dealType":{"type":"string","description":"Type of security indexation"},"index":{"type":"string","description":"Benchmark used as reference"},"yield":{"type":"number","description":"Security return based on dealType and index","format":"float"},"issuanceFaceValue":{"type":"number","description":"Face value of the asset","example":100,"format":"float"},"interestPaymentPeriod":{"type":"string","description":"Bond payment frequency","example":"BULLET","enum":["BULLET","MONTHLY","EVERY_2_MONTHS","EVERY_3_MONTHS","EVERY_4_MONTHS","EVERY_6_MONTHS","YEARLY"]},"classifications":{"description":"Security classifications","type":"array","items":{"$ref":"#/components/schemas/SecurityClassificationDto"}},"scaleType":{"type":"string","description":"Floating rate scale type","example":"RETROACTIVE","enum":["NONE","INCREMENTAL","RETROACTIVE"]},"scaling":{"description":"Floating rate scaling over time","type":"array","items":{"$ref":"#/components/schemas/SecurityFloatingRateScalingDto"}},"anbimaFundName":{"type":"string","description":"ANBIMA fund name","example":"Fundo de Investimento em Cotas de Fundos de Investimento RIVO FIDC"},"anbimaFundId":{"type":"string","description":"ANBIMA fund identification","example":"F0000261599"},"anbimaClassName":{"type":"string","description":"ANBIMA class name","example":"RIVO FIDC"},"anbimaClassId":{"type":"string","description":"ANBIMA class identification","example":"C0000261599"},"anbimaSubclassName":{"type":"string","description":"ANBIMA subclass name","example":"SÊNIOR"},"anbimaSubclassId":{"type":"string","description":"ANBIMA subclass identification","example":"S0000261599"},"cvmClassId":{"type":"string","description":"CVM class identification","example":"1"},"cvmSubclassId":{"type":"string","description":"CVM subclass identification","example":"1"},"createdDate":{"type":"string","description":"Date of the creation of the security","example":"2022-05-16","format":"iso8601"},"daysToSettlement":{"type":"number","description":"Number of days to settlement","example":2,"format":"float"}},"required":["id","assetClass","type","name"],"title":"SecurityDto"},"SecurityPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Next page URL","example":"https://core.gorila.com.br/portfolio/49f430fd-cbbc-4235-ad1b-fa232c271715/transaction?token=224d7310ba1b4e5396f2fa1097834165","format":"url"},"records":{"description":"Array of resulting records","type":"array","items":{"$ref":"#/components/schemas/SecurityDto"}}},"required":["next","records"],"title":"SecurityPageDto"},"SecurityUpdateDto":{"type":"object","properties":{"classificationId":{"type":"string","description":"Identifier of the security classification. Null to remove custom classification","example":"VARIABLE_INCOME","nullable":true,"minLength":1},"maturityDate":{"type":"string","description":"Security maturity date, or null to reset it","example":"2050-04-04","nullable":true,"format":"iso8601 (YYYY-MM-DD)"},"taxIncentivized":{"type":"boolean","description":"Indicates whether the security has tax incentives.","example":true},"name":{"type":"string","description":"Name identifying the custom security","example":"Apartment","minLength":1},"description":{"type":"string","description":"Longer description for the custom security,useful for the user to better identify and differentiate between them","example":"Apartment located in São Paulo","minLength":1},"daysToSettlement":{"type":"number","description":"Number of days to settlement, or null to reset it","example":2,"nullable":true,"minimum":0,"format":"float"}},"title":"SecurityUpdateDto"}}},"x-tagGroups":[{"name":"Root Resources","tags":["Benchmarks","Brokers","Corporate Bonds","Economic Groups","Issuers","Investment Profiles","Portfolios","Securities"]},{"name":"Security Resources","tags":["Price Conversions","Security Prices","Security Events","Security Classifications","Security KPIs"]},{"name":"Economic Group Resources","tags":["Economic Groups Drawdown","Economic Group Invested Amount","Economic Groups Liquidity","Economic Groups Net Asset Value","Economic Groups Profit & Losses","Economic Groups Time-Weighted Return","Economic Groups Positions","Economic Groups Security Events","Economic Groups Sharpe Ratio","Economic Groups Transactions","Economic Groups Volatility"]},{"name":"Economic Group Position Resources","tags":["Economic Group Positions Average Price","Economic Group Positions Internal Rate of Return","Economic Group Positions Market Values","Economic Group Positions Profit & Losses","Economic Group Positions Time-Weighted Return","Economic Group Positions Security Prices","Economic Group Positions Invested Amount","Economic Group Positions Liquidity"]},{"name":"Portfolio Resources","tags":["Drawdown","Net Asset Value","Invested Amount","Liquidity","Profit & Losses","Positions","Portfolio Security Events","Portfolio Target Allocation","Sharpe Ratio","Transactions","Time-Weighted Return","Volatility"]},{"name":"Position Resources","tags":["Average Prices","Internal Rate of Return","Market Values","Position Allocation","Position Invested Amount","Position Liquidity","Position Profit & Losses","Position Time-Weighted Return","Position Security Prices","Dividend Yield"]}]}