{ "swagger": "2.0", "info": { "description": "APIs for Securities Lending Electronic Trading", "version": "1.0", "title": "BTB", "termsOfService": "127.0.0.1", "contact": { "name": "BTB", "email": "sat@b3.com.br", "url": "http://b3.com.br/" } }, "host": "127.0.0.1:8052", "schemes": [ "https" ], "basePath": "/api", "tags": [ { "name": "Order", "description": "Place an order publication into the order book" }, { "name": "Book", "description": "Instrument in the Book" }, { "name": "Trade", "description": "Trade of the Buy-Side" }, { "name": "Event", "description": "Events of the offers and business" } ], "paths": { "/v1.0/Order/Entry": { "post": { "tags": [ "Order" ], "summary": "Place an order publication into the order book", "description": "Place an order publication into the order book", "operationId": "OrderEntrypost", "parameters": [ { "in": "body", "name": "Order", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrderEntryReqpost" } } ], "responses": { "200": { "description": "LendingOrder successful response", "schema": { "$ref": "#/definitions/OrderRsppost" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/HitLender": { "post": { "tags": [ "Order" ], "summary": "Hit a specific lender order in order book", "description": "Hit a specific lender order in order book", "operationId": "Order/HitLenderpost", "parameters": [ { "in": "body", "name": "Order/HitLender", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrderHitLenderReqpost" } } ], "responses": { "200": { "description": "HitLenderOrder successful response", "schema": { "$ref": "#/definitions/OrderHitRsppost" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/HitBorrower": { "post": { "tags": [ "Order" ], "summary": "Hit a specific borrower order in order book", "description": "Hit a specific borrower order in order book", "operationId": "Order/HitBorrowerpost", "parameters": [ { "in": "body", "name": "Order/HitBorrower", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrderHitBorrowerReqpost" } } ], "responses": { "200": { "description": "/Order/HitBorrower successful response", "schema": { "$ref": "#/definitions/OrderHitRsppost" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/Cancel": { "post": { "tags": [ "Order" ], "summary": "Cancel a specific order in order book", "description": "Cancel a specific order in order book", "operationId": "Order/Cancelpost", "parameters": [ { "in": "body", "name": "Order/Cancel", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrderCancelReqpost" } } ], "responses": { "200": { "description": "Order/Cancel successful response", "schema": { "$ref": "#/definitions/OrderRsppost" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/Cancel/All": { "post": { "tags": [ "Order" ], "summary": "Cancel all orders of a specific participant available in order book", "description": "Cancel all orders of a specific participant available in order book", "operationId": "Order/Cancel/Allpost", "parameters": [ { "in": "body", "name": "Order/Cancel/All", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrderCancelAllReqpost" } } ], "responses": { "200": { "description": "Order/Cancel/All successful response", "schema": { "$ref": "#/definitions/OrderCancelAllRsppost" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Book/List/{symbol}/{daysToSettlementIndicator}": { "get": { "tags": [ "Book" ], "summary": "Return Best Orders List", "description": "", "operationId": "Book/Listget", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "symbol", "description": "Code that identifies the instrument", "required": true, "type": "string" }, { "in": "path", "name": "daysToSettlementIndicator", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Book/List/ successful response", "schema": { "$ref": "#/definitions/BookListRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Book/Top/{symbol}/{daysToSettlementIndicator}": { "get": { "tags": [ "Book" ], "summary": "Get best orders of one or more instruments (limited to 50)", "description": "Get best orders of one or more instruments (limited to 50)", "operationId": "Book/Topget", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "symbol", "description": "Code that identifies the instrument", "required": true, "type": "array", "items": { "type": "string" }, "maxItems": 50 }, { "in": "path", "name": "daysToSettlementIndicator", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Book/Top successful response", "schema": { "$ref": "#/definitions/BookTopRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/{code}": { "get": { "tags": [ "Order" ], "summary": "Return a specific order included by the Buy-Side", "description": "Return a specific order included by the Buy-Side", "operationId": "Orderget", "parameters": [ { "name": "code", "in": "path", "description": "Code that identifies the offer operation.", "required": true, "type": "string", "maxLength": 35 } ], "responses": { "200": { "description": "Orderget successful response", "schema": { "$ref": "#/definitions/OrderRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/List": { "get": { "tags": [ "Order" ], "summary": "Return Order List", "description": "", "operationId": "Order/Listget", "parameters": [ { "name": "partyCode", "in": "query", "description": "Operational code (old fantasy code) that identifies the participant", "type": "string", "maxLength": 35, "required": true }, { "name": "number", "in": "query", "description": "Number that identifies the account of the investor", "type": "string", "maxLength": 35 }, { "name": "symbol", "in": "query", "description": "Code that identifies the instrument", "type": "string", "maxLength": 12 }, { "name": "daysToSettlementIndicator", "in": "query", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "type": "number", "pattern": "^[0-1]{1}" }, { "name": "offerCode", "in": "query", "description": "Code that identifies the offer operation.", "type": "string", "maxLength": 35 }, { "name": "offerTypeCode", "in": "query", "description": "Code that identifies the order type. Domain (1 - Lender, 2 - Borrower)", "type": "string", "maxLength": 1 } ], "responses": { "200": { "description": "Order/Listget successful response", "schema": { "$ref": "#/definitions/OrderListRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Order/Status/{code}": { "get": { "tags": [ "Order" ], "summary": "Return status of a specific order", "description": "Return status of a specific order", "operationId": "Order/Statusget", "parameters": [ { "name": "code", "in": "path", "description": "Code that identifies the offer operation.", "required": true, "type": "string", "maxLength": 35 } ], "responses": { "200": { "description": "Order/Statusget successful response", "schema": { "$ref": "#/definitions/OrderStatusRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Trade/All/{symbol}/{daysToSettlementIndicator}": { "get": { "tags": [ "Trade" ], "summary": "Return All Orders", "description": "", "operationId": "Trade/Allget", "parameters": [ { "name": "symbol", "in": "path", "description": "Code that identifies the instrument", "required": true, "type": "string", "maxLength": 12 }, { "name": "daysToSettlementIndicator", "in": "path", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "required": true, "type": "number", "pattern": "^[0-1]{1}" } ], "responses": { "200": { "description": "Trade/All successful response", "schema": { "$ref": "#/definitions/TradeAllRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Trade/{code}": { "get": { "tags": [ "Trade" ], "summary": "Return a specific trade", "description": "", "operationId": "Tradeget", "parameters": [ { "name": "code", "in": "path", "description": "Code that identifies the instrument", "required": true, "type": "string", "maxLength": 35 } ], "responses": { "200": { "description": "TradeRspget successful response", "schema": { "$ref": "#/definitions/TradeRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Trade/List": { "get": { "tags": [ "Trade" ], "summary": "Return a list of Trades of the Buy-Side", "description": "Return a list of Trades of the Buy-Side", "operationId": "Trade/Listget", "parameters": [ { "name": "partyCode", "in": "query", "description": "Operational code (old fantasy code) that identifies the participant", "required": true, "type": "string", "maxLength": 35 }, { "name": "number", "in": "query", "description": "Number that identifies the account of the investor", "type": "string", "maxLength": 35 }, { "name": "symbol", "in": "query", "description": "Code that identifies the instrument", "type": "string", "maxLength": 12 }, { "name": "daysToSettlementIndicator", "in": "query", "description": "Settlement period. Domain (0 = D + 0, 1 = D + 1)", "type": "number", "pattern": "^[0-1]{1}" }, { "name": "offerTypeCode", "in": "query", "description": "Code that identifies the type order. Domain values (1=Lender, 2=Borrower)", "type": "string", "maxLength": 1 }, { "name": "date", "in": "query", "description": "Trading date indicator. Domain (0 - D + 0, 1 - D - 1)", "type": "number", "pattern": "^[0-1]{1}", "required": true }, { "name": "lenderCode", "in": "query", "description": "Code that identifies the offer operation.", "type": "string", "maxLength": 35 }, { "name": "borrowerCode", "in": "query", "description": "Code that identifies the offer operation.", "type": "string", "maxLength": 35 }, { "name": "tradeCode", "in": "query", "description": "Code that identifies the trade operation", "type": "string", "maxLength": 35 } ], "responses": { "200": { "description": "Trade/ListReqget successful response", "schema": { "$ref": "#/definitions/TradeListRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Trade/Status/{code}": { "get": { "tags": [ "Trade" ], "summary": "Return the status of a specific trade", "description": "Return the status of a specific trade", "operationId": "Trade/Statusget", "parameters": [ { "name": "code", "in": "path", "description": "Code that identifies the trade operation", "required": true, "type": "string", "maxLength": 35 } ], "responses": { "200": { "description": "Trade/StatusRspget successful response", "schema": { "$ref": "#/definitions/TradeStatusRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v1.0/Event/{startDate}": { "get": { "tags": [ "Event" ], "summary": "Return the events related to offers and business by time interval", "description": "Return the events related to offers and business by time interval", "operationId": "Eventget", "parameters": [ { "name": "startDate", "in": "path", "description": "Specifies the date/time on which the offer was initial", "required": true, "type": "string", "format": "dateTime" } ], "responses": { "200": { "description": "EnventRspget successful response", "schema": { "$ref": "#/definitions/EventRspget" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } } }, "definitions": { "OrderHitRsppost": { "type": "object", "properties": { "Trade": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the trade operation.", "example": null }, "tradeStatus": { "type": "number", "description": "Number that identifies the trade status", "example": null } } }, "BusinesStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the business status", "example": null } } } } }, "OrderRsppost": { "type": "object", "properties": { "Offer": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null }, "offerStatus": { "type": "number", "description": "Number that identifies the order status", "example": null } } }, "BusinesStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "OrderEntryReqpost": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null } } } } }, "Custodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null } } } } }, "Security": { "type": "object", "properties": { "symbol": { "type": "string", "maxLength": 12, "description": "Code that identifies the instrument", "example": "PETR4" } } }, "Offer": { "type": "object", "properties": { "daysToSettlementIndicator": { "type": "number", "pattern": "^[0-1]{1}", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "example": null }, "certifiedOfferIndicator": { "type": "boolean", "maxLength": 1, "description": "Indicates if a lender order is certified. Domain (S - YES, N - NO)", "example": null }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "pattern": "^[0-9]{0,11}[.,]{1}[0-9]{0,5}", "description": "Order rate", "example": null }, "expirationDate": { "type": "string", "description": "The last day that the instrument is valid", "example": null }, "OfferType": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 1, "description": "Code that identifies the order type. Domain (1 - Lender, 2 - Borrower)", "example": null } } }, "Finality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. Subaccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } } }, "OrderHitLenderReqpost": { "type": "object", "properties": { "BorrowerParty": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null } } } } }, "BorrowerCustodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null } } } } }, "LenderOffer": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "BorrowerFinality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. Subaccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } } }, "OrderHitBorrowerReqpost": { "type": "object", "properties": { "LenderParty": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null } } } } }, "LenderCustodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null } } } } }, "BorrowerOffer": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "certifiedOfferIndicator": { "type": "boolean", "description": "Indicates if a lender order is certified. Domain (S - YES, N - NO)", "example": null }, "LenderFinality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. Subaccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } } }, "OrderCancelReqpost": { "type": "object", "properties": { "Offer": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null } } } } }, "OrderCancelAllReqpost": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null } } } } }, "OrderCancelAllRsppost": { "type": "object", "properties": { "Offer": { "type": "object", "properties": { "offerStatus": { "type": "number", "description": "Number that identifies the order status", "example": null } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "BookTopRspget": { "type": "object", "properties": { "SecurityList": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Code that identifies the instrument", "example": "PETR4" }, "LenderOffer": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "description": "Order rate", "example": null }, "Party": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null } } } } }, "BorrowerOffer": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "description": "Order rate", "example": null }, "Party": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null } } } } } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "BookListRspget": { "type": "object", "properties": { "Security": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Code that identifies the instrument", "example": "PETR4" }, "LenderOfferList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "description": "Order rate", "example": null }, "Party": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null } } } } } }, "BorrowerOfferList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "description": "Order rate", "example": null }, "Party": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null } } } } } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "OrderRspget": { "type": "object", "properties": { "Offer": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "description": "Number that identifies the account of the investor", "example": null }, "name": { "type": "string", "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Custodian": { "type": "object", "properties": { "code": { "type": "string", "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "description": "Number that identifies the account of the investor", "example": null }, "name": { "type": "string", "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Security": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Code that identifies the instrument", "example": "PETR4" } } }, "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "daysToSettlementIndicator": { "type": "number", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "example": null }, "certifiedOfferIndicator": { "type": "boolean", "description": "Indicates if a order is certified. Domain (S - YES, N - NO)", "example": null }, "originalQuantity": { "type": "number", "description": "Specifies the original offer quantity.", "example": null }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "description": "Order rate", "example": null }, "expirationDate": { "type": "string", "description": "The last day that the instrument is valid", "example": null }, "offerStatus": { "type": "number", "description": "Order status", "example": null }, "OfferType": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the order type. Domain (1 - Lender, 2 - Borrower)", "example": null } } }, "Finality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. Subaccount is a collection of investments all owned by the same individual or organization", "example": null } } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "OrderListRspget": { "type": "object", "properties": { "OfferList": { "type": "array", "items": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Acccount": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Custodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Security": { "type": "object", "properties": { "symbol": { "type": "string", "maxLength": 12, "description": "Code that identifies the instrument", "example": "PETR4" } } }, "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "daysToSettlementIndicator": { "type": "number", "pattern": "^[0-1]{1}", "description": "Settlement period. Domain (0 - D+0, 1 - D+1)", "example": null }, "certifiedOfferIndicator": { "type": "boolean", "description": "Indicates if the order is certified. Domain (S - YES, N - NO)", "example": null }, "originalQuantity": { "type": "number", "description": "Specifies the original offer quantity.", "example": null }, "quantity": { "type": "number", "description": "Order quantity", "example": null }, "rate": { "type": "number", "pattern": "^[0-9]{0,11}[.,]{1}[0-9]{0,5}", "description": "Order rate", "example": null }, "expirationDate": { "type": "string", "description": "The last day that the instrument is valid", "example": null }, "offerStatus": { "type": "number", "description": "Ordering Status", "example": null }, "OfferType": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status. Domain (1 - Lender, 2 - Borrower)", "example": null } } }, "Finality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. Subaccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } }, "TrafficInformation": { "type": "object", "properties": { "returnRecordQuantity": { "type": "number", "description": "Quantity of returned records", "example": null } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "OrderStatusRspget": { "type": "object", "properties": { "Offer": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "offerStatus": { "type": "number", "description": "Ordering status", "example": null } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the trade status", "example": null } } } } }, "TradeAllRspget": { "type": "object", "properties": { "Security": { "type": "object", "properties": { "symbol": { "type": "string", "maxLength": 12, "description": "Code that identifies the instrument", "example": "PETR4" } } }, "TradeList": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Specifies the date/time on which the trade was executed.", "example": null }, "rate": { "type": "number", "pattern": "^[0-9]{0,11}[.,]{1}[0-9]{0,5}$", "description": "Rate of the trade", "example": null }, "quantity": { "type": "number", "description": "Quantity of financial instruments of the trade.", "example": null } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the trade status", "example": null } } } } }, "TradeRspget": { "type": "object", "properties": { "Trade": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "party": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "CounterParty": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the clearing house or central counter party", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name of the clearing house or central counter party", "example": null } } } } }, "Custodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Security": { "type": "object", "properties": { "symbol": { "type": "string", "maxLength": 12, "description": "Code that identifies the instrument", "example": "PETR4" } } }, "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the trade operation", "example": null }, "daysToSettlementIndicator": { "type": "number", "pattern": "^[0-1]{1}", "description": "Settlement period. Domain (0 = D + 0, 1 = D + 1)", "example": null }, "date": { "type": "string", "description": "Specifies the date/time on which the trade was executed", "example": null }, "quantity": { "type": "number", "description": "Quantity of financial instruments of the trade", "example": null }, "expirationDate": { "type": "string", "description": "The last day that the instrument is valid", "example": null }, "rate": { "type": "number", "pattern": "^[0-9]{0,11}[.,]{1}[0-9]{0,5}$", "description": "Rate of the trade", "example": null }, "tradeStatus": { "type": "string", "description": "Trade Status", "example": null }, "TradeType": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 1, "description": "Code that identifies the type of order. Domain values (1=Lender, 2=Borrower)", "example": null } } }, "Offer": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null }, "counterpartyOfferCode": { "type": "string", "maxLength": 35, "description": "Counterpart Order Number", "example": null }, "Finality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the subAccount. SubAccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "TradeListRspget": { "type": "object", "properties": { "TradeList": { "type": "array", "items": { "type": "object", "properties": { "Party": { "type": "object", "properties": { "party": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the account of the investor", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "CounterParty": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the clearing house or central counter party", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name of the clearing house or central counter party", "example": null } } } } }, "Custodian": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 35, "description": "Operational code (old fantasy code) that identifies the participant", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Participant's name", "example": null }, "Account": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 35, "description": "Number that identifies the investor's acccount at the custodian", "example": null }, "name": { "type": "string", "maxLength": 60, "description": "Name by which a party is known and which is usually used to identify that entity", "example": null } } } } }, "Security": { "type": "object", "properties": { "symbol": { "type": "string", "maxLength": 12, "description": "Code that identifies the instrument", "example": "PETR4" } } }, "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the trade operation", "example": null }, "date": { "type": "string", "description": "Specifies the date/time on which the trade was executed. Domain ( 0 D+0, 1 D-1 )", "example": null }, "quantity": { "type": "number", "description": "Trade quantity", "example": null }, "expirationDate": { "type": "string", "description": "The last day that the instrument is valid", "example": null }, "rate": { "type": "number", "pattern": "^[0-9]{0,11}[.,]{1}[0-9]{0,5}$", "description": "Trade of thr trade.", "example": null }, "tradeStatus": { "type": "number", "description": "Trade Status", "example": null }, "TradeType": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the type order. Domain values: (1=Lender, 2=Borrower)", "example": null } } }, "Offer": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the offer operation.", "example": null, "maxLength": 35 }, "counterpartyOfferCode": { "type": "string", "description": "Counterpart order number", "example": null, "maxLength": 35 }, "Finality": { "type": "object", "properties": { "code": { "type": "number", "description": "Code that identifies the SubAccount. SubAccount is a collection of investments all owned by the same individual or organization", "example": null } } } } } } } }, "TrafficInformation": { "type": "object", "properties": { "returnRecordQuantity": { "type": "number", "description": "Quantity of returned records", "example": null } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies the trade status", "example": null } } } } }, "TradeStatusRspget": { "type": "object", "properties": { "Trade": { "type": "object", "properties": { "tradeStatus": { "type": "number", "description": "Trade Status", "example": null } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies of the trade status", "example": null } } } } }, "EventRspget": { "type": "object", "properties": { "OfferList": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "dateTime", "description": "Specifies the date/time on which the offer was executed.", "example": null }, "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the offer operation.", "example": null }, "originalQuantity": { "type": "number", "description": "Specifies the original offer quantity.", "example": null }, "quantity": { "type": "number", "description": "Current amount of assets of the order.", "example": null }, "offerStatus": { "type": "string", "maxLength": 60, "description": "Offer status.", "example": null }, "TradeList": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "dateTime", "description": "-> Specifies the date/time on which the trade was executed", "example": null }, "code": { "type": "string", "maxLength": 35, "description": "Code that identifies the position.", "example": null }, "quantity": { "type": "number", "description": "Quantity of financial instruments of the trade.", "example": null }, "tradeStatus": { "type": "number", "description": "Trade Status", "example": null } } } } } } }, "BusinessStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Code that identifies of the trade status", "example": null } } } } } } }