{"items":[{"type":"link","label":"REST API","link":"/openapi/integral-api-reference/rest","routeSlug":"/openapi/integral-api-reference/rest","content":{"contentType":"overview","meta":{"name":"REST API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Integral","url":"https://integral.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"REST API (1.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the Integral REST API reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our REST API is for less latency-sensitive participants and has resource-oriented URLs, accepts JSON-encoded requests, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Integral’s account management team to get connection details and credentials for access."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest"}],"sectionId":"/openapi/integral-api-reference/rest"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication-options"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication options"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can choose between two authentication methods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authentication-options%2FToken-based-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authentication-options%2FHMAC-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC authentication"},"children":[]}]}]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication-options/token-based-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ID and password will be issued to you to generate and refresh/renew an access token. All REST API calls should pass this token to access authenticated services."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/token-based-authentication"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/token-based-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/get-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users should use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/login"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/v2/sso/login"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get an access token. The access token is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSO_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response header. Your token is valid for a limited time."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/get-token"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/get-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/pass-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token should be sent in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSO_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of request headers."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/pass-token"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/pass-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/renew-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renew token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To keep your session alive, you can renew your token with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/renewToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/sso/tokens/renew"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If your token is expired, you are issued a new token."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/renew-token"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/renew-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication-options/hmac-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this authentication method, you must sign each API request with a 'secret'. The 'secret' and 'userId' are issued to you during set up."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All REST requests must contain following header information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"10%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header attribute "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base64-encoded signature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A date and time as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard UTC string"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digest"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHA-256=base64(sha256(<body>))"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is no request body, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Digest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be set to the digest of a body of 0 length."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmac"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must send an authorization header with the following parameterization:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"credentials := \"hmac\" params\nparams := userId \",\" algorithm \", \" headers \", \" signature\nuserId := \"username\" \"=\" plain-string\nalgorithm := \"algorithm\" \"=\" DQUOTE (hmac-sha256) DQUOTE\nheaders := \"headers\" \"=\" plain-string\nsignature := \"signature\" \"=\" plain-string\nplain-string   = DQUOTE *( %x20-21 / %x23-5B / %x5D-7E ) DQUOTE\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"credentials := \"hmac\" params\nparams := userId \",\" algorithm \", \" headers \", \" signature\nuserId := \"username\" \"=\" plain-string\nalgorithm := \"algorithm\" \"=\" DQUOTE (hmac-sha256) DQUOTE\nheaders := \"headers\" \"=\" plain-string\nsignature := \"signature\" \"=\" plain-string\nplain-string   = DQUOTE *( %x20-21 / %x23-5B / %x5D-7E ) DQUOTE\n"},"children":[]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/hmac-authentication"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/hmac-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/signature-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"15%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credential."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"algorithm"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital signature algorithm used to create the signature. You should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmac-sha256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of HTTP header names, separated by a single space character, used to sign the request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded digital signature generated by the client."},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/signature-parameters"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/signature-parameters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/sample-authorization-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sample authorization header"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: hmac userId=\"user2@XCN1139\",\n  algorithm=\"hmac-sha256\",\n  headers=\"date content-type content-length\",\n  signature=\"XWL1oxJsbC4z3UvO6ZfvgjMvfj249WXSb7Gl/+t/Ql0=\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: hmac userId=\"user2@XCN1139\",\n  algorithm=\"hmac-sha256\",\n  headers=\"date content-type content-length\",\n  signature=\"XWL1oxJsbC4z3UvO6ZfvgjMvfj249WXSb7Gl/+t/Ql0=\"\n"},"children":[]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/sample-authorization-header"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/sample-authorization-header"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication-options/signature-string-construction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature string construction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate the string that is signed with a secret, the client must take the values of each HTTP header specified by headers in the order they appear."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header name is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request-line"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then append the lowercase header name followed with an ASCII colon "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an ASCII space "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"' '"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header name is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request-line"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then append the HTTP request line (in ASCII format), otherwise append the header value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is not the last value, then append an ASCII newline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The string must not include a trailing ASCII newline."},"children":[]}]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/signature-string-construction"}],"sectionId":"/openapi/integral-api-reference/rest/section/authentication-options/signature-string-construction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/api-tracing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API tracing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Request-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the request's HTTP header to trace each API call. The system echos back this header in the response."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/api-tracing"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/status-and-error-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status and error codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All Integral REST APIs use the following general status codes. See endpoints for specific codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"15%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP code "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful submission."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request accepted by the system. You are expected to make another API call. Refer to individual API sections and endpoints for subsequent action."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is an issue with request parameters. May have a message body that indicates the error. Refer to individual API sections and endpoints for specific errors."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNAUTHORIZED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your IntegralAPI user is not authorized. May have a message body that indicates the error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT FOUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint could not be found. Either your valid request did not return any results or your request was malformed. May have a message body that indicates the error. Refer to individual API endpoints to confirm that the endpoint URL and parameters are correct."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INTERNAL SERVER ERROR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop trading immediately and contact Integral Business Support with a complete error message and full details of the HTTP request and response. May have a message body that indicates the error."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4xx and 5xx status codes may return a JSON response body with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/status-and-error-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/reason-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You determine the status of any call with a combination of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code from the messaging technology (for example, REST/HTTP codes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason code for the server. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all responses include a reason code."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the following codes to interpret and act on status responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"55%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason code "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order size is invalid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.CoIdNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client order ID not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.DuplicateOrder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order already exists for the given client order ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.TypeNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.TIFNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time in force not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.SideNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order side (buy or sell) not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.CurrencyNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order dealt currency not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.InvalidDealtCcy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt currency is neither base currency nor term currency."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.SymbolNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symbol not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.InvalidCurrencyPair"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Symbol not valid or not supported by the system."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.SizeNotSpecified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order size not specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.InvalidOrderQty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order size not valid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.InvalidPrice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted price invalid. Zero is invalid price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.BuySellMismatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy/Sell side of the accepted price is incorrect."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.InvalidQuoteID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rateId of the previously quoted (PQ) order is invalid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.LegalEntitySetIncorrectly"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account field incorrect."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.OrderTypeNotSupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type not supported."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.PriceMismatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted price not the same as previously quoted price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.QuoteExpired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate associated with the rateId not found. It has expired. Price is no longer valid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequestValidationError.tradingDisabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trading is disabled."},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/openapi/integral-api-reference/rest/section/reason-codes"}]}]}},{"type":"group","label":"Authentication options","link":"/openapi/integral-api-reference/rest/section/authentication-options","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options","items":[{"type":"link","label":"Token-based authentication","link":"/openapi/integral-api-reference/rest/section/authentication-options/token-based-authentication","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/token-based-authentication","content":null},{"type":"link","label":"Get token","link":"/openapi/integral-api-reference/rest/section/authentication-options/get-token","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/get-token","content":null},{"type":"link","label":"Pass token","link":"/openapi/integral-api-reference/rest/section/authentication-options/pass-token","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/pass-token","content":null},{"type":"link","label":"Renew token","link":"/openapi/integral-api-reference/rest/section/authentication-options/renew-token","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/renew-token","content":null},{"type":"link","label":"HMAC authentication","link":"/openapi/integral-api-reference/rest/section/authentication-options/hmac-authentication","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/hmac-authentication","content":null},{"type":"link","label":"Signature parameters","link":"/openapi/integral-api-reference/rest/section/authentication-options/signature-parameters","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/signature-parameters","content":null},{"type":"link","label":"Sample authorization header","link":"/openapi/integral-api-reference/rest/section/authentication-options/sample-authorization-header","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/sample-authorization-header","content":null},{"type":"link","label":"Signature string construction","link":"/openapi/integral-api-reference/rest/section/authentication-options/signature-string-construction","routeSlug":"/openapi/integral-api-reference/rest/section/authentication-options/signature-string-construction","content":null}],"content":null},{"type":"link","label":"API tracing","link":"/openapi/integral-api-reference/rest/section/api-tracing","routeSlug":"/openapi/integral-api-reference/rest/section/api-tracing","content":null},{"type":"link","label":"Status and error codes","link":"/openapi/integral-api-reference/rest/section/status-and-error-codes","routeSlug":"/openapi/integral-api-reference/rest/section/status-and-error-codes","content":null},{"type":"link","label":"Reason codes","link":"/openapi/integral-api-reference/rest/section/reason-codes","routeSlug":"/openapi/integral-api-reference/rest/section/reason-codes","content":null},{"type":"group","label":"Authentication API","link":"/openapi/integral-api-reference/rest/authentication-api","routeSlug":"/openapi/integral-api-reference/rest/authentication-api","items":[{"label":"Login and get token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/authentication-api/login","routeSlug":"/openapi/integral-api-reference/rest/authentication-api/login","metadata":{"seo":{"title":"Login and get token","description":"Use the ID and password issued to you to login and generate and refresh/renew an access token. All REST API calls should pass this token to access authenticated services."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"login","name":"Login and get token","isWebhook":false,"pointer":"/paths/~1v2~1sso~1login/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login and get token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the ID and password issued to you to login and generate and refresh/renew an access token. All REST API calls should pass this token to access authenticated services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access token is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSO_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response header. Your token is valid for a limited time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_332","exampleIds":["paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1sso~1login/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/sso/login","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/v2/sso/login","href":"authentication-api/login","openApiOperationId":"login","summary":"Login and get token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"schema_332","exampleIds":["paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with token expiry time. The access token is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSO_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_333","exampleIds":["paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example"],"headers":{"Set-Cookie":{"description":"May be several in header. One contains token.","schema":{"type":"string","maxLength":255},"example":"SSO_TOKEN=hidH61Uy63IYT08avDFEUUrEO_Sn-BZ6yEqyON5SJS_h0gU8vOaNItVGllwHTH7yFZgFtFN9jYlSRTHEBIBKNQ; Domain=.integral.com; Path=/"}},"headerSchemaId":"schema_334"},{"code":"400","description":"Bad request."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid user/organization supplied"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid password"},"children":[]}]}]}]}]},{"code":"404","description":"Malformed request."}],"pointer":"/paths/~1v2~1sso~1login/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_333","exampleIds":["paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-api/login"}],"panels":[]}]},"httpPath":"/v2/sso/login"},{"label":"Renew token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/authentication-api/renewtoken","routeSlug":"/openapi/integral-api-reference/rest/authentication-api/renewtoken","metadata":{"seo":{"title":"Renew token","description":"To keep your session alive, use the ID and password issued to you to renew your token. If your token is expired, you are issued a new token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renewToken","name":"Renew token","isWebhook":false,"pointer":"/paths/~1v2~1sso~1token~1renew/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renew token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"To keep your session alive, use the ID and password issued to you to renew your token. If your token is expired, you are issued a new token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/sso/token/renew","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v2/sso/token/renew","href":"authentication-api/renewtoken","openApiOperationId":"renewToken","summary":"Renew token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with updated token expiry time. If your token was expired, the new access token is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSO_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335","exampleIds":["paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_335","exampleIds":["paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Malformed request"},{"code":"500","description":"No active session"}],"pointer":"/paths/~1v2~1sso~1token~1renew/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_335","exampleIds":["paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335","exampleIds":["paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-api/renewtoken"}],"panels":[]}]},"httpPath":"/v2/sso/token/renew"}],"content":{"contentType":"group","meta":{"name":"Authentication API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication API","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to login with token-based authentication."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/sso/login","summary":"Login and get token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-api/login","deprecated":false},{"title":"/v2/sso/token/renew","summary":"Renew token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication-api/renewtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Market data","link":"/openapi/integral-api-reference/rest/market-data","routeSlug":"/openapi/integral-api-reference/rest/market-data","items":[{"label":"Get spot rate by symbol","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getspotrate","routeSlug":"/openapi/integral-api-reference/rest/market-data/getspotrate","metadata":{"seo":{"title":"Get spot rate by symbol","description":"Get real-time, top-of-book spot bid and offer rates for a given symbol. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpotRate","name":"Get spot rate by symbol","isWebhook":false,"pointer":"/paths/~1v2~1rates~1spot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get spot rate by symbol","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get real-time, top-of-book spot bid and offer rates for a given symbol. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rates~1spot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rates/spot","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"symbol","in":"query","required":true,"example":"EUR/USD","schemaId":"schema_336"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/rates/spot","href":"market-data/getspotrate","openApiOperationId":"getSpotRate","summary":"Get spot rate by symbol"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A spot rate object with top-of-book spot rates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/spotRate-TOB","exampleIds":["paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate"]}},"schemaId":"components/schemas/spotRate-TOB","exampleIds":["paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No rates found for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your request was malformed."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1rates~1spot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/spotRate-TOB","exampleIds":["paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/spotRate-TOB","exampleIds":["paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getspotrate"}],"panels":[]}]},"httpPath":"/v2/rates/spot"},{"label":"Get spot rate by type and symbol","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getspotratebytype","routeSlug":"/openapi/integral-api-reference/rest/market-data/getspotratebytype","metadata":{"seo":{"title":"Get spot rate by type and symbol","description":"Get real-time spot bid and offer rates by rate type and symbol. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpotRateByType","name":"Get spot rate by type and symbol","isWebhook":false,"pointer":"/paths/~1v2~1rates~1spot~1{type}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get spot rate by type and symbol","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get real-time spot bid and offer rates by rate type and symbol. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_337","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of rates requested: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=top of book, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=full book, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RAW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=raw rates"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rates~1spot~1{type}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rates~1spot~1{type}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rates/spot/{type}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"schema_337"}],"query":[{"name":"symbol","in":"query","required":true,"example":"EUR/USD","schemaId":"schema_336"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/rates/spot/{type}","href":"market-data/getspotratebytype","openApiOperationId":"getSpotRateByType","summary":"Get spot rate by type and symbol"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A spot rate object with one or more spot rates depending on the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates"]}},"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No rates found for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your request was malformed."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1rates~1spot~1{type}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getspotratebytype"}],"panels":[]}]},"httpPath":"/v2/rates/spot/{type}"},{"label":"Get spot rate by type and symbol for organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getspotratebytypeorg","routeSlug":"/openapi/integral-api-reference/rest/market-data/getspotratebytypeorg","metadata":{"seo":{"title":"Get spot rate by type and symbol for organization","description":"Get real-time spot bid and offer rates by rate type and symbol from liquidity providers for an organization. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpotRateByTypeOrg","name":"Get spot rate by type and symbol for organization","isWebhook":false,"pointer":"/paths/~1v2~1rates~1spot~1{type}~1{org}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get spot rate by type and symbol for organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get real-time spot bid and offer rates by rate type and symbol from liquidity providers for an organization. Returns an aggregated list of rates, which may include prices from multiple liquidity providers or external market data sources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_339","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of rates requested: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=top of book, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=full book, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RAW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=raw rates"},"children":[]}]}]}],"required":true},{"name":"org","in":"path","schemaId":"schema_340","description":"Organization ID of requesting user. Rates returned are from liquidity providers configured for the organization.","required":true}],"pointer":"/paths/~1v2~1rates~1spot~1{type}~1{org}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rates~1spot~1{type}~1{org}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rates/spot/{type}/{org}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"type","in":"path","required":true,"example":"TOB","schemaId":"schema_339"},{"name":"org","in":"path","required":true,"example":"BrokerOrgA1","schemaId":"schema_340"}],"query":[{"name":"symbol","in":"query","required":true,"example":"EUR/USD","schemaId":"schema_336"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/rates/spot/{type}/{org}","href":"market-data/getspotratebytypeorg","openApiOperationId":"getSpotRateByTypeOrg","summary":"Get spot rate by type and symbol for organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A spot rate object with one or more spot rates depending on the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates"]}},"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No rates found for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your request was malformed."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers","paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getspotratebytypeorg"}],"panels":[]}]},"httpPath":"/v2/rates/spot/{type}/{org}"},{"label":"Get market data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getmarketdataset","routeSlug":"/openapi/integral-api-reference/rest/market-data/getmarketdataset","metadata":{"seo":{"title":"Get market data","description":"Get rates from market data sets (MDSs) managed by the Integral Pricing engine."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMarketDataSet","name":"Get market data","isWebhook":false,"pointer":"/paths/~1v2~1marketdataset/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get market data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get rates from market data sets (MDSs) managed by the Integral Pricing engine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MDS workflow determines the parameters you need to send and the type of rates you receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular workflow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#eod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day workflow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#fp"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed-period workflow"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"id":"rt"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Regular workflow"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A regular MDS contains active market rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required parameter values for regular rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include the ID of a regular MDS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must omit this parameter for regular rates. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a regular MDS and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, an error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-regular-rates-for-a-single-currency-pair-spot-for-today's-business-date","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-regular-rates-for-a-single-currency-pair-spot-for-today's-business-date"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: regular rates for a single currency pair, SPOT, for today's business date"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=RealTimeMDS&symbol=EUR/USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-regular-rates-for-multiple-currency-pairs-1-week-outright-for-today's-business-date","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-regular-rates-for-multiple-currency-pairs-1-week-outright-for-today's-business-date"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: regular rates for multiple currency pairs, 1-week outright, for today's business date"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=RealTimeMDS&symbols=EUR/USD,USD/JPY,USD/CAD&tenor=1W"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"id":"eod"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"End-of-day workflow"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An end-of-day MDS contains reference rates and is active after a specific time, typically after the end of the business day."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required parameter values for end-of-day rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include the ID of an end-of-day MDS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must omit this parameter for end-of-day rates. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a end-of-day MDS and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, an error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-end-of-date-rates-for-a-single-currency-pair-spot-for-today's-business-date","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-end-of-date-rates-for-a-single-currency-pair-spot-for-today's-business-date"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: end-of-date rates for a single currency pair, SPOT, for today's business date"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=EODMDS&symbol=EUR/USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-end-of-date-rates-for-a-single-currency-pair-spot-for-a-specific-date","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-end-of-date-rates-for-a-single-currency-pair-spot-for-a-specific-date"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: end-of-date rates for a single currency pair, SPOT, for a specific date"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=EODMDS&symbol=EUR/USD&date=2024-10-24"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"id":"fp"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fixed-period workflow"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fixed-period MDS contains rates generated at a specific time and that are active and valid during a specified time window with a start and end time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required parameter values for fixed-period rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not include both. Specify the MDS ID for fixed-period rates from a specific fixed-period MDS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not include both. Specify the organization ID for rates from all fixed-period MDSs for the organization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-fixed-period-rates-for-a-single-currency-pair-spot-for-today's-business-date","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-fixed-period-rates-for-a-single-currency-pair-spot-for-today's-business-date"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: fixed-period rates for a single currency pair, SPOT, for today's business date"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=FixedPeriodMDS&symbol=EUR/USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-fixed-period-rates-for-a-single-currency-pair-spot-for-a-specific-date-active-during-a-specific-time-window","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-fixed-period-rates-for-a-single-currency-pair-spot-for-a-specific-date-active-during-a-specific-time-window"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: fixed-period rates for a single currency pair, SPOT, for a specific date, active during a specific time window"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?id=FixedPeriodMDS&symbol=EUR/USD&date=2024-10-24&timeWindow=1500-1700"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"market-data/getmarketdataset/request/example:-all-fixed-period-mdss-for-an-organization-spot-for-a-specific-date-active-during-a-specific-time-window","deepLinkHash":"/market-data/getmarketdataset#market-data/getmarketdataset/request/example:-all-fixed-period-mdss-for-an-organization-spot-for-a-specific-date-active-during-a-specific-time-window"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: all fixed-period MDSs for an organization, SPOT, for a specific date, active during a specific time window"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/marketdataset?org=organizationID&date=2024-10-24&timeWindow=1500-1700"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_341","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of market data set from the Integral Pricing Engine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for regular market data sets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional for EOD and fixed-period market data sets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not included, you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not include both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your request."},"children":[]}]}]}],"examples":{"RealTime":{"summary":"You must include an ID for regular market data.","value":"RealTimeMDS"},"EOD":{"summary":"Include an EOD market-data set ID for exclusively EOD market data. You may omit the ID to receive EOD and fixed-period market data.","value":"EODMDS"},"FixedPeriod":{"summary":"Include a fixed-period market-data set ID for exclusively fixed-period market data. You may omit the ID to receive EOD and fixed-period market data.","value":"FixedPeriodMDS"}}},{"name":"org","in":"query","schemaId":"schema_342","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the organization that the market-data-set pricing stream is assigned to by the Integral Pricing Engine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit for regular market data sets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not included, you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not include both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your request."},"children":[]}]}]}],"required":true},{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash \"/\". Optional for fixed-period workflow. For regular and end-of-day workflows, you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]}],"required":true},{"name":"symbols","in":"query","schemaId":"schema_343","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of currency pairs. Each currency pair consists of base and term currencies separated by a slash \"/\" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD,USD/JPY,NZD/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Optional for fixed-period workflow. For regular and end-of-day workflows, you must include either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If neither is included, an error is returned."},"children":[]}]}]}],"required":true},{"name":"date","in":"query","schemaId":"schema_344","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business date for the market data set in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, the current business date is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable only to end-of-day and fixed-period MDSs. Ignored for regular MDSs."},"children":[]}]}]}]},{"name":"tenor","in":"query","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MDS tenor. If not specified, all rates configured in the MDS are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": overnight (today)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tomorrow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot next (spot+1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of days after the current business date (for example, 1D, 2D, 10D)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of weeks after the current business date (for example, 1W, 2W, 3W)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of months after the current business date (for example, 1M, 2M, 3M)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of years after the current business date (for example, 1Y, 2Y, 3Y)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The next International Monetary Market (IMM) settlement date. IMM dates are the third Wednesday of the last month of every quarter (March, June, September, December). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in the next IMM date on or after the spot date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in two IMM dates after the spot date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (spot + IMM) for swaps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (tomorrow + IMM) for swaps"},"children":[]}]}]}]}]},{"name":"timeWindow","in":"query","schemaId":"schema_346","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time in 24-hour format during which the market date set is active, either a discrete time "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hhmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a time period with a start time and end time "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hhmm-hhmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not specified, currently active market data sets are returned."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1marketdataset/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/marketdataset","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":false,"example":"RealTimeMDS","schemaId":"schema_341"},{"name":"org","in":"query","required":true,"example":"BNK1-4HOrg","schemaId":"schema_342"},{"name":"symbol","in":"query","required":true,"example":"EUR/USD","schemaId":"schema_336"},{"name":"symbols","in":"query","required":true,"example":"EUR/USD,USD/JPY","schemaId":"schema_343"},{"name":"date","in":"query","required":false,"example":"2024-10-24","schemaId":"schema_344"},{"name":"tenor","in":"query","required":false,"schemaId":"schema_345"},{"name":"timeWindow","in":"query","required":false,"example":"1500-1700","schemaId":"schema_346"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v2/marketdataset","href":"market-data/getmarketdataset","openApiOperationId":"getMarketDataSet","summary":"Get market data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A market data set object containing one or more rates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/marketDataSetResponse","exampleIds":["paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS"]}},"schemaId":"components/schemas/marketDataSetResponse","exampleIds":["paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS"]},{"code":"400","description":"Missing request parameter, invalid request parameter, or your organization is not configured for fixed-period pricing."},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1marketdataset/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/marketDataSetResponse","exampleIds":["paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/marketDataSetResponse","exampleIds":["paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates","paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS"]}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getmarketdataset"}],"panels":[]}]},"httpPath":"/v2/marketdataset"},{"label":"Get benchmark","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getbenchmark","routeSlug":"/openapi/integral-api-reference/rest/market-data/getbenchmark","metadata":{"seo":{"title":"Get benchmark","description":"Get the Integral FX benchmark rate for a given symbol."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBenchmark","name":"Get benchmark","isWebhook":false,"pointer":"/paths/~1v2~1benchmark/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get benchmark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the Integral FX benchmark rate for a given symbol."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_347","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1benchmark/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/benchmark","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"symbol","in":"query","required":true,"example":"AUD/USD","schemaId":"schema_347"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/benchmark","href":"market-data/getbenchmark","openApiOperationId":"getBenchmark","summary":"Get benchmark"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An object with the Integral FX benchmark rate.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}},"schemaId":"schema_348"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No benchmark found for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your request was malformed."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1benchmark/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_348","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getbenchmark"}],"panels":[]}]},"httpPath":"/v2/benchmark"},{"label":"Get ticker","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/market-data/getticker","routeSlug":"/openapi/integral-api-reference/rest/market-data/getticker","metadata":{"seo":{"title":"Get ticker","description":"Get the last traded price for a given symbol."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTicker","name":"Get ticker","isWebhook":false,"pointer":"/paths/~1v2~1ticker/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ticker","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the last traded price for a given symbol."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1ticker/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/ticker","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"symbol","in":"query","required":true,"example":"EUR/USD","schemaId":"schema_336"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/ticker","href":"market-data/getticker","openApiOperationId":"getTicker","summary":"Get ticker"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An object with the last traded price.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No last traded price found for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your request was malformed."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1ticker/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/market-data/getticker"}],"panels":[]}]},"httpPath":"/v2/ticker"}],"content":{"contentType":"group","meta":{"name":"Market data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Market data","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to get prices, indicative rates, benchmark rates, and trade ticker rates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/rates/spot","summary":"Get spot rate by symbol","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getspotrate","deprecated":false},{"title":"/v2/rates/spot/{type}","summary":"Get spot rate by type and symbol","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getspotratebytype","deprecated":false},{"title":"/v2/rates/spot/{type}/{org}","summary":"Get spot rate by type and symbol for organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getspotratebytypeorg","deprecated":false},{"title":"/v2/marketdataset","summary":"Get market data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getmarketdataset","deprecated":false},{"title":"/v2/benchmark","summary":"Get benchmark","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getbenchmark","deprecated":false},{"title":"/v2/ticker","summary":"Get ticker","prefix":{"name":"get","color":"get"},"badges":[],"link":"/market-data/getticker","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/integral-api-reference/rest/orders","routeSlug":"/openapi/integral-api-reference/rest/orders","items":[{"label":"Place order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/orders/placeorder","routeSlug":"/openapi/integral-api-reference/rest/orders/placeorder","metadata":{"seo":{"title":"Place order","description":"Place a new order. You can place various types of order such as limit, market, at best, previously quoted, stop, algo, pegged, and more. Under algo orders you can execute various strategies such as TWAP."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placeOrder","name":"Place order","isWebhook":false,"pointer":"/paths/~1v2~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Place order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Place a new order. You can place various types of order such as limit, market, at best, previously quoted, stop, algo, pegged, and more. Under algo orders you can execute various strategies such as TWAP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns status code 202 if your order is accepted by the system for processing. Use the query order endpoints to get the current status of your order "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByServerId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (server ID)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get all trades associated with an order using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderAllFills"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query all trades on an order by ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Trades contain information like counterparty, settlement date, and amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"orders/placeorder/request/required-request-attributes-for-all-order-types","deepLinkHash":"/orders/placeorder#orders/placeorder/request/required-request-attributes-for-all-order-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required request attributes for all order types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All place-order requests must have the following attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"side"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"orders/placeorder/request/conditionally-required-request-attributes-and-values","deepLinkHash":"/orders/placeorder#orders/placeorder/request/conditionally-required-request-attributes-and-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditionally required request attributes and values"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request may require additional attributes based on the order type or attribute values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you place an order with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (good-til-canceled) you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiryTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required attributes and values"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit(IOC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=IOC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit(GTC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit(GTT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiryTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Market(IOC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Market"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=IOC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At best"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=AtBest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=FOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stopPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"execFlags=BidTrigger|OfferTrigger|MidTrigger"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously quoted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=PQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=FOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateId"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Algo (TWAP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=Algo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetStrategy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On behalf of"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"org"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderRequest","exampleIds":["paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"]}},"schemaId":"components/schemas/orderRequest","exampleIds":["paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"],"pointer":"/paths/~1v2~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/orders","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/orderRequest","exampleIds":["paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"]}},"responseCodes":["202","400","401"],"pointer":"/v2/orders","href":"orders/placeorder","openApiOperationId":"placeOrder","summary":"Place order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/orderRequest","exampleIds":["paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderRequest","exampleIds":["paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted","paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order accepted by system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response contains an order object with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigned by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByServerId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (server ID)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the current status of your order."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf"]}},"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf"]},{"code":"400","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General error message. Required parameters missing or invalid. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter sent, check the returned order for missing required parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incomplete Currency Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid coId, client order id can not be null or blank"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RequestValidationError.OrderAmount.LessThanAllowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order amount in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter of the place order request is smaller than the minimum order size."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RequestValidationError.OrderAmount.MoreThanAllowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order amount in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter of the place order request is larger than the maximum order size."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RequestValidationError.DeliverToCompIDSetup"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For previously quoted (PQ) orders. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in the place order request does not match an existing rate ID from the current liquidity provider."},"children":[]}]}]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch"]}},"exampleIds":["paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch"]},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v2~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ","paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf"]}}},{"code":"400","exampleIds":["paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize","paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch"]}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/placeorder"}],"panels":[]}]},"httpPath":"/v2/orders"},{"label":"Query order (client ID or all active orders)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/orders/queryorderbyclientid","routeSlug":"/openapi/integral-api-reference/rest/orders/queryorderbyclientid","metadata":{"seo":{"title":"Query order (client ID or all active orders)","description":"Get the order for the given client order ID. Omit the request parameter coId to return all active orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderByClientId","name":"Query order (client ID or all active orders)","isWebhook":false,"pointer":"/paths/~1v2~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query order (client ID or all active orders)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the order for the given client order ID. Omit the request parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return all active orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"coId","in":"query","schemaId":"schema_350","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigned by you when you placed the order. Omit to return all active orders."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/orders","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"coId","in":"query","required":false,"example":"Order25","schemaId":"schema_350"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/orders","href":"orders/queryorderbyclientid","openApiOperationId":"queryOrderByClientId","summary":"Query order (client ID or all active orders)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An array of orders that match the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId"]}},"schemaId":"schema_351","exampleIds":["paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId"]},{"code":"404","description":"No order found for the given client order ID or your request was malformed."}],"pointer":"/paths/~1v2~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_351","exampleIds":["paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled","paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/queryorderbyclientid"}],"panels":[]}]},"httpPath":"/v2/orders"},{"label":"Cancel all orders","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/orders/cancelallorders","routeSlug":"/openapi/integral-api-reference/rest/orders/cancelallorders","metadata":{"seo":{"title":"Cancel all orders","description":"With best effort, cancel all active orders. This may require you to make the request multiple times until all of the open active orders are cancelled. You can call Query order (client ID or all active orders) to check if any order is still active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelAllOrders","name":"Cancel all orders","isWebhook":false,"pointer":"/paths/~1v2~1orders/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel all orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With best effort, cancel all active orders. This may require you to make the request multiple times until all of the open active orders are cancelled. You can call "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check if any order is still active."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/orders","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["202","404"],"pointer":"/v2/orders","href":"orders/cancelallorders","openApiOperationId":"cancelAllOrders","summary":"Cancel all orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your cancel request has been accepted for processing. Attempting to cancel all active orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check if any order is still active."},"children":[]}]}]}]}]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1orders/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/cancelallorders"}],"panels":[]}]},"httpPath":"/v2/orders"},{"label":"Query order (server ID)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/orders/queryorderbyserverid","routeSlug":"/openapi/integral-api-reference/rest/orders/queryorderbyserverid","metadata":{"seo":{"title":"Query order (server ID)","description":"Get the order for the given server order ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderByServerId","name":"Query order (server ID)","isWebhook":false,"pointer":"/paths/~1v2~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query order (server ID)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the order for the given server order ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_352","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID assigned by the server when your order was placed. Returned in response in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/orders/{id}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"4820276016","schemaId":"schema_352"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/orders/{id}","href":"orders/queryorderbyserverid","openApiOperationId":"queryOrderByServerId","summary":"Query order (server ID)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order that matches the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled"]}},"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled"]},{"code":"404","description":"No order found for the given server order ID or your request was malformed."}],"pointer":"/paths/~1v2~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order","exampleIds":["paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending","paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/queryorderbyserverid"}],"panels":[]}]},"httpPath":"/v2/orders/{id}"},{"label":"Cancel individual order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/orders/cancelorder","routeSlug":"/openapi/integral-api-reference/rest/orders/cancelorder","metadata":{"seo":{"title":"Cancel individual order","description":"Cancel a single active order by ID (the unique ID assigned by server, received in the place order response). Use Query order (server ID) or Query order (client ID or all active orders) to get the current status of your order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelOrder","name":"Cancel individual order","isWebhook":false,"pointer":"/paths/~1v2~1orders~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel individual order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a single active order by ID (the unique ID assigned by server, received in the place order response). Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByServerId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (server ID)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the current status of your order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_353","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID assigned by the server when your order was placed. Returned in response in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1orders~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/orders/{id}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"4820275011","schemaId":"schema_353"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["202","404"],"pointer":"/v2/orders/{id}","href":"orders/cancelorder","openApiOperationId":"cancelOrder","summary":"Cancel individual order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request to cancel the order has been accepted for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to get the current status of your order:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByServerId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (server ID)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderByClientId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query order (client ID or all active orders)"},"children":[]}]}]}]}]}]}]}]},{"code":"404","description":"The given server order ID was not found or your request was malformed."}],"pointer":"/paths/~1v2~1orders~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/cancelorder"}],"panels":[]}]},"httpPath":"/v2/orders/{id}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Place, cancel, and query orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/orders","summary":"Place order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/placeorder","deprecated":false},{"title":"/v2/orders","summary":"Query order (client ID or all active orders)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/queryorderbyclientid","deprecated":false},{"title":"/v2/orders","summary":"Cancel all orders","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/cancelallorders","deprecated":false},{"title":"/v2/orders/{id}","summary":"Query order (server ID)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/queryorderbyserverid","deprecated":false},{"title":"/v2/orders/{id}","summary":"Cancel individual order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/cancelorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Trades","link":"/openapi/integral-api-reference/rest/trades","routeSlug":"/openapi/integral-api-reference/rest/trades","items":[{"label":"Book trade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/booktrade","routeSlug":"/openapi/integral-api-reference/rest/trades/booktrade","metadata":{"seo":{"title":"Book trade","description":"Enter trades done in other systems."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bookTrade","name":"Book trade","isWebhook":false,"pointer":"/paths/~1v2~1trades/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Book trade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enter trades done in other systems."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeExternal","exampleIds":["paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"]}},"schemaId":"components/schemas/tradeExternal","exampleIds":["paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"],"pointer":"/paths/~1v2~1trades/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tradeExternal","exampleIds":["paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"]}},"responseCodes":["200","400","404","500"],"pointer":"/v2/trades","href":"trades/booktrade","openApiOperationId":"bookTrade","summary":"Book trade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/tradeExternal","exampleIds":["paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeExternal","exampleIds":["paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap","paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID and creation time of the book trade in Integral’s system."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}},"schemaId":"schema_354"},{"code":"400","description":"A required attribute on the request body is missing or contains an invalid value."},{"code":"404","description":"Your request was malformed."},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is empty. If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your request, you must include a value."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1trades/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}}},{"code":"400"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/booktrade"}],"panels":[]}]},"httpPath":"/v2/trades"},{"label":"Query all trades on an order by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/queryorderallfills","routeSlug":"/openapi/integral-api-reference/rest/trades/queryorderallfills","metadata":{"seo":{"title":"Query all trades on an order by ID","description":"Get all fills for the order ID assigned by Integral returned in the coId or orderId field when the order was placed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderAllFills","name":"Query all trades on an order by ID","isWebhook":false,"pointer":"/paths/~1v2~1trades/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query all trades on an order by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all fills for the order ID assigned by Integral returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when the order was placed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"coId","in":"query","schemaId":"schema_355","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID assigned by you when your order was placed. Returned in response in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"required":true},{"name":"orderId","in":"query","schemaId":"schema_356","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID assigned by Integral when your order was placed. Returned in response in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1trades/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/trades","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"coId","in":"query","required":true,"example":"OrderXEL278vv1","schemaId":"schema_355"},{"name":"orderId","in":"query","required":true,"example":"4820275011","schemaId":"schema_356"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/trades","href":"trades/queryorderallfills","openApiOperationId":"queryOrderAllFills","summary":"Query all trades on an order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An array of trade objects. If an empty array, no trades were done for the given server order ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1v2~1trades/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_357","exampleIds":["paths/~1v2~1trades/get/responses/200/content/application~1json/example"]},{"code":"404","description":"There were no trades for the given order ID or your request was malformed."}],"pointer":"/paths/~1v2~1trades/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_357","exampleIds":["paths/~1v2~1trades/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1v2~1trades/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/queryorderallfills"}],"panels":[]}]},"httpPath":"/v2/trades"},{"label":"Amend trade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/tradeamend","routeSlug":"/openapi/integral-api-reference/rest/trades/tradeamend","metadata":{"seo":{"title":"Amend trade","description":"Amend a verified trade by amount, rate, customer, or all three. Available to broker users and sales dealer users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tradeAmend","name":"Amend trade","isWebhook":false,"pointer":"/paths/~1v2~1trades~1amendment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Amend trade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amend a verified trade by amount, rate, customer, or all three. Available to broker users and sales dealer users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify at least one property in addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Work with your Integral Technical Account Manager to configure the following trade amendment restrictions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of minutes during which a trade is eligible for amendment after verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of price amend requests allowed for a trade. Each request to change a rate property ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spotRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forwardPoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") counts against the total allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum amount a trade can be amended expressed as a percentage of the trade’s size. If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dealtAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value must be greater than zero and less than this maximum."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeAmendRequest","exampleIds":["paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"]}},"schemaId":"components/schemas/tradeAmendRequest","exampleIds":["paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"],"pointer":"/paths/~1v2~1trades~1amendment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades/amendment","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tradeAmendRequest","exampleIds":["paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"]}},"responseCodes":["200","400","401"],"pointer":"/v2/trades/amendment","href":"trades/tradeamend","openApiOperationId":"tradeAmend","summary":"Amend trade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/tradeAmendRequest","exampleIds":["paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeAmendRequest","exampleIds":["paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ID of the amended trade.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358"},{"code":"400","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": trade ID not present in the system or a trade in a state that cannot be amended."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_dealtAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": amount is negative or greater than the allowed percentage, if configured."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_spotRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty or null."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_customerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty or not found in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": amend request results in no change to the specified trade."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_rate_or_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": rate and amount values result in a triangulation error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_tradingRelationship"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requesting user does not belong to the maker or taker organization on the trade."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"malformed_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request or properties not formatted correctly (for example, amount properties contain other than numeric values)."},"children":[]}]}]}]}]},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v2~1trades~1amendment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/tradeamend"}],"panels":[]}]},"httpPath":"/v2/trades/amendment"},{"label":"Roll trade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/traderoll","routeSlug":"/openapi/integral-api-reference/rest/trades/traderoll","metadata":{"seo":{"title":"Roll trade","description":"Roll a trade to another value date. Available to broker users and sales dealer users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tradeRoll","name":"Roll trade","isWebhook":false,"pointer":"/paths/~1v2~1trades~1roll/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roll trade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Roll a trade to another value date. Available to broker users and sales dealer users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeRollRequest","exampleIds":["paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade","paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"]}},"schemaId":"components/schemas/tradeRollRequest","exampleIds":["paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade","paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"],"pointer":"/paths/~1v2~1trades~1roll/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades/roll","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tradeRollRequest","exampleIds":["paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade","paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"]}},"responseCodes":["200","400","401"],"pointer":"/v2/trades/roll","href":"trades/traderoll","openApiOperationId":"tradeRoll","summary":"Roll trade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/tradeRollRequest","exampleIds":["paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade","paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeRollRequest","exampleIds":["paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade","paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID and creation time of the book trade in Integral’s system."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": trade ID not present in the system or a trade in a state that cannot be rolled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_valueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": incorrect format, invalid date, or not a business date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_fixingDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": incorrect format, invalid date, or not a business date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"malformed_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request or properties not formatted correctly (for example, amount properties contain other than numeric values)."},"children":[]}]}]}]}]},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v2~1trades~1roll/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/traderoll"}],"panels":[]}]},"httpPath":"/v2/trades/roll"},{"label":"Allocate trade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/tradeallocate","routeSlug":"/openapi/integral-api-reference/rest/trades/tradeallocate","metadata":{"seo":{"title":"Allocate trade","description":"Divide a trade into post-trade allocations among multiple legal entities of the same organization. Available to broker users and sales dealer users. Customer organizations can be configured to allocate trades."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tradeAllocate","name":"Allocate trade","isWebhook":false,"pointer":"/paths/~1v2~1trades~1allocations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocate trade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Divide a trade into post-trade allocations among multiple legal entities of the same organization. Available to broker users and sales dealer users. Customer organizations can be configured to allocate trades.\n\nYou must ensure that the allocated amounts equal the original trade amount.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeAllocateRequest","exampleIds":["paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"]}},"schemaId":"components/schemas/tradeAllocateRequest","exampleIds":["paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"],"pointer":"/paths/~1v2~1trades~1allocations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades/allocations","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tradeAllocateRequest","exampleIds":["paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"]}},"responseCodes":["200","400","401"],"pointer":"/v2/trades/allocations","href":"trades/tradeallocate","openApiOperationId":"tradeAllocate","summary":"Allocate trade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/tradeAllocateRequest","exampleIds":["paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeAllocateRequest","exampleIds":["paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Original trade ID and allocation IDs.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_360","exampleIds":["paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": trade ID not present in the system or a trade in a state that cannot be allocated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty, null, or longer than the max length."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty, null, or outside min/max length."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_allocationAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty, invalid, or total allocated amounts don't equal the original trade amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_customerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty or not found in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_side"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty or not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"malformed_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request or properties not formatted correctly (for example, amount properties contain other than numeric values)."},"children":[]}]}]}]}]},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v2~1trades~1allocations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","exampleIds":["paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/tradeallocate"}],"panels":[]}]},"httpPath":"/v2/trades/allocations"},{"label":"Cancel trades","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/tradecancel","routeSlug":"/openapi/integral-api-reference/rest/trades/tradecancel","metadata":{"seo":{"title":"Cancel trades","description":"Cancel individual trades by trade ID or one or more trades by your trade request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tradeCancel","name":"Cancel trades","isWebhook":false,"pointer":"/paths/~1v2~1trades~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel individual trades by trade ID or one or more trades by your trade request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientRequestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all other parameters are ignored."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeCancelRequest","exampleIds":["paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId","paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"]}},"schemaId":"components/schemas/tradeCancelRequest","exampleIds":["paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId","paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"],"pointer":"/paths/~1v2~1trades~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades/cancel","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tradeCancelRequest","exampleIds":["paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId","paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"]}},"responseCodes":["200","400","401"],"pointer":"/v2/trades/cancel","href":"trades/tradecancel","openApiOperationId":"tradeCancel","summary":"Cancel trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/tradeCancelRequest","exampleIds":["paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId","paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tradeCancelRequest","exampleIds":["paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId","paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361"},{"code":"400","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_customerOrg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty or not found in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": trade ID not present in the system or a trade in a state that cannot be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_clientReferenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": empty, outside min/max length, or no trades found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"malformed_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request or properties not formatted correctly (for example, amount properties contain other than numeric values)."},"children":[]}]}]}]}]},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v2~1trades~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/tradecancel"}],"panels":[]}]},"httpPath":"/v2/trades/cancel"},{"label":"Query trade by trade ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/trades/querytrade","routeSlug":"/openapi/integral-api-reference/rest/trades/querytrade","metadata":{"seo":{"title":"Query trade by trade ID","description":"Get trade details for a given trade ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryTrade","name":"Query trade by trade ID","isWebhook":false,"pointer":"/paths/~1v2~1trades~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query trade by trade ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get trade details for a given trade ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_362","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integral trade ID. Returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryOrderAllFills"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query order fills"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/bookTrade"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"book trade"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1trades~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/trades/{id}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"FXI9222877182","schemaId":"schema_362"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/trades/{id}","href":"trades/querytrade","openApiOperationId":"queryTrade","summary":"Query trade by trade ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The trade object. If empty, no trade matched the given Integral trade ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/trade","exampleIds":["paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById","paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams"]}},"schemaId":"components/schemas/trade","exampleIds":["paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById","paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams"]},{"code":"404","description":"No trade with the given trade ID or your request was malformed."}],"pointer":"/paths/~1v2~1trades~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/trade","exampleIds":["paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById","paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/trade","exampleIds":["paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById","paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/querytrade"}],"panels":[]}]},"httpPath":"/v2/trades/{id}"}],"content":{"contentType":"group","meta":{"name":"Trades"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trades","showPageActions":true},{"nodeType":"markdoc","content":"Trade operations (book, query, amend, roll, allocate, cancel). Also query orders for fills.\n\nOnly brokers and sales dealers can amend, roll, and allocate by default. Customer organizations can be configured to allocate trades (work with your Integral Technical Account Manager)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/trades","summary":"Book trade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trades/booktrade","deprecated":false},{"title":"/v2/trades","summary":"Query all trades on an order by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/queryorderallfills","deprecated":false},{"title":"/v2/trades/amendment","summary":"Amend trade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trades/tradeamend","deprecated":false},{"title":"/v2/trades/roll","summary":"Roll trade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trades/traderoll","deprecated":false},{"title":"/v2/trades/allocations","summary":"Allocate trade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trades/tradeallocate","deprecated":false},{"title":"/v2/trades/cancel","summary":"Cancel trades","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trades/tradecancel","deprecated":false},{"title":"/v2/trades/{id}","summary":"Query trade by trade ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/querytrade","deprecated":false}]}]}]}]}},{"type":"group","label":"RFS/RFQ","link":"/openapi/integral-api-reference/rest/rfsrfq","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq","items":[{"label":"Request quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest","metadata":{"seo":{"title":"Request quote","description":"Send a quote request to receive firm quotes from liquidity providers for the specified symbol, tenor, amount, and direction (bid, ask, two-way) for a given price type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quoteRequest","name":"Request quote","isWebhook":false,"pointer":"/paths/~1v2~1rfs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a quote request to receive firm quotes from liquidity providers for the specified symbol, tenor, amount, and direction (bid, ask, two-way) for a given price type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the initial success response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must query the status of your request to receive the latest quotes and status (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryRequestServerID"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query quote request (server ID)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/queryRequestClientID"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query quote request (client ID)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you receive a quote, you can then accept it ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/acceptquote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rfsRequest","exampleIds":["paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"]}},"schemaId":"components/schemas/rfsRequest","exampleIds":["paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"],"pointer":"/paths/~1v2~1rfs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/rfs","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/rfsRequest","exampleIds":["paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"]}},"responseCodes":["202","400","404"],"pointer":"/v2/rfs","href":"rfsrfq/quoterequest","openApiOperationId":"quoteRequest","summary":"Request quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/rfsRequest","exampleIds":["paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rfsRequest","exampleIds":["paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ","paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirmation with your request ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the server request ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and request status in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rfsResponseSuccess","exampleIds":["paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/rfsResponseSuccess","exampleIds":["paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success"]},{"code":"400","description":"Request Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1v2~1rfs/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_363","exampleIds":["paths/~1v2~1rfs/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1rfs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/rfsResponseSuccess","exampleIds":["paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rfsResponseSuccess","exampleIds":["paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success"]}}},{"code":"400","schemaId":"schema_363","exampleIds":["paths/~1v2~1rfs/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1v2~1rfs/post/responses/400/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfsrfq/quoterequest"}],"panels":[]}]},"httpPath":"/v2/rfs"},{"label":"Query quote request (client ID)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/rfsrfq/queryrequestclientid","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq/queryrequestclientid","metadata":{"seo":{"title":"Query quote request (client ID)","description":"Query the state of quote request by the RFS ID clOrderId assigned by you when you sent the request. The response can include quotes, trades, and state of the Quote request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRequestClientID","name":"Query quote request (client ID)","isWebhook":false,"pointer":"/paths/~1v2~1rfs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query quote request (client ID)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query the state of quote request by the RFS ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigned by you when you sent the request. The response can include quotes, trades, and state of the Quote request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clOrderId","in":"query","schemaId":"schema_364","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID assigned by you when you submitted the request. Sent in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the request."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rfs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rfs","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"clOrderId","in":"query","required":true,"example":"view1MultiLP5","schemaId":"schema_364"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/rfs","href":"rfsrfq/queryrequestclientid","openApiOperationId":"queryRequestClientID","summary":"Query quote request (client ID)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A JSON object with the quote status. May include quotes and trades.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired"]}},"schemaId":"schema_365","exampleIds":["paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired"]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1rfs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_365","exampleIds":["paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfsrfq/queryrequestclientid"}],"panels":[]}]},"httpPath":"/v2/rfs"},{"label":"Query quote request (server ID)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/rfsrfq/queryrequestserverid","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq/queryrequestserverid","metadata":{"seo":{"title":"Query quote request (server ID)","description":"Query the state of quote request by the RFS ID assigned by Integral. The response can include quotes, trades, and state of the Quote request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRequestServerID","name":"Query quote request (server ID)","isWebhook":false,"pointer":"/paths/~1v2~1rfs~1{requestId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query quote request (server ID)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query the state of quote request by the RFS ID assigned by Integral. The response can include quotes, trades, and state of the Quote request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rfs~1{requestId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rfs/{requestId}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"example":"G4796976d517b1786e1fa242","schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/rfs/{requestId}","href":"rfsrfq/queryrequestserverid","openApiOperationId":"queryRequestServerID","summary":"Query quote request (server ID)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A JSON object with the quote status. May include quotes and trades.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired"]}},"schemaId":"schema_367","exampleIds":["paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired"]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1rfs~1{requestId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_367","exampleIds":["paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled","paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfsrfq/queryrequestserverid"}],"panels":[]}]},"httpPath":"/v2/rfs/{requestId}"},{"label":"Accept quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/rfsrfq/acceptquote","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq/acceptquote","metadata":{"seo":{"title":"Accept quote","description":"Accept a quote from liquidity providers that you requested (Request quote)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptQuote","name":"Accept quote","isWebhook":false,"pointer":"/paths/~1v2~1rfs~1{requestId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept a quote from liquidity providers that you requested ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rfs~1{requestId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/acceptQuote","exampleIds":["paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS","paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"]}},"schemaId":"components/schemas/acceptQuote","exampleIds":["paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS","paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"],"pointer":"/paths/~1v2~1rfs~1{requestId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/rfs/{requestId}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"example":"G4796976d517b1786e1fa242","schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/acceptQuote","exampleIds":["paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS","paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"]}},"responseCodes":["202","404"],"pointer":"/v2/rfs/{requestId}","href":"rfsrfq/acceptquote","openApiOperationId":"acceptQuote","summary":"Accept quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/acceptQuote","exampleIds":["paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS","paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/acceptQuote","exampleIds":["paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS","paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Quote accepted. Response has no message body."},{"code":"404","description":"Not found. The requestID provided could not be found. Response has no message body."}],"pointer":"/paths/~1v2~1rfs~1{requestId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfsrfq/acceptquote"}],"panels":[]}]},"httpPath":"/v2/rfs/{requestId}"},{"label":"Withdraw quote request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/rfsrfq/withdrawquoterequest","routeSlug":"/openapi/integral-api-reference/rest/rfsrfq/withdrawquoterequest","metadata":{"seo":{"title":"Withdraw quote request","description":"Withdraw an active quote request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"withdrawQuoteRequest","name":"Withdraw quote request","isWebhook":false,"pointer":"/paths/~1v2~1rfs~1{requestId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Withdraw quote request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Withdraw an active quote request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1rfs~1{requestId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/rfs/{requestId}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"example":"G4796976d517b1786e1fa242","schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["202","404"],"pointer":"/v2/rfs/{requestId}","href":"rfsrfq/withdrawquoterequest","openApiOperationId":"withdrawQuoteRequest","summary":"Withdraw quote request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted response with no message body."},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quote request with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" could not be found. Response has no message body."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1rfs~1{requestId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfsrfq/withdrawquoterequest"}],"panels":[]}]},"httpPath":"/v2/rfs/{requestId}"}],"content":{"contentType":"group","meta":{"name":"RFS/RFQ"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RFS/RFQ","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFS/RFQ endpoints provide API access to two trading workflows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for Stream (RFS): a stream of firm quotes from liquidity providers against your quote request for a symbol, tenor, amount, and direction for a given price type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for Quote (RFQ): a single quote good for a duration you request. The server must be configured to enable the RFQ workflow. Please contact your Technical Account Manager to discuss settings."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You receive responses against your RFS and RFQ requests using the Query request response API and can choose to either accept the quote, withdraw your quote request, or you can allow the your request or quote to expire."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for Stream (RFS) workflow:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send your request:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the symbol, tenor, amount, and buy/sell direction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest#rfsrfq/quoterequest/t=request&path=rfq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfq"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest#rfsrfq/quoterequest/t=request&path=expiry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to the expiration time of your stream request."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query the state of your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do one of the following:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdraw your quote request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let your quote request expire."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request for Quote (RFQ) workflow:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send your request:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the symbol, tenor, amount, and buy/sell direction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest#rfsrfq/quoterequest/t=request&path=rfq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfq"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/integral-api-reference/rest/rfsrfq/quoterequest#rfsrfq/quoterequest/t=request&path=expiry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to your requested duration of the quote."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query the state of your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do one of the following:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdraw your quote request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let your quote request expire."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/rfs","summary":"Request quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfsrfq/quoterequest","deprecated":false},{"title":"/v2/rfs","summary":"Query quote request (client ID)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rfsrfq/queryrequestclientid","deprecated":false},{"title":"/v2/rfs/{requestId}","summary":"Query quote request (server ID)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rfsrfq/queryrequestserverid","deprecated":false},{"title":"/v2/rfs/{requestId}","summary":"Accept quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfsrfq/acceptquote","deprecated":false},{"title":"/v2/rfs/{requestId}","summary":"Withdraw quote request","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rfsrfq/withdrawquoterequest","deprecated":false}]}]}]}]}},{"type":"group","label":"Positions","link":"/openapi/integral-api-reference/rest/positions","routeSlug":"/openapi/integral-api-reference/rest/positions","items":[{"label":"Positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/positions/getpositions","routeSlug":"/openapi/integral-api-reference/rest/positions/getpositions","metadata":{"seo":{"title":"Positions","description":"Get open positions. All parameters are optional. If no parameters are specified, all open positions for the logged-in user are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPositions","name":"Positions","isWebhook":false,"pointer":"/paths/~1v2~1positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Positions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get open positions. All parameters are optional. If no parameters are specified, all open positions for the logged-in user are returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"level","in":"query","schemaId":"schema_368","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. The level at which the position is calculated, case sensitive:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": legal entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": organization"},"children":[]}]}]}]}],"examples":{"user":{"summary":"User level","value":"USER"},"legalEntity":{"summary":"Legal-entity level","value":"LE"},"organization":{"summary":"Organization level","value":"ORG"}}},{"name":"value","in":"query","schemaId":"schema_369","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. The ID of a specific org, legal entity, or user (depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/positions","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"symbol","in":"query","required":false,"example":"EUR/USD","schemaId":"schema_336"},{"name":"level","in":"query","required":false,"example":"USER","schemaId":"schema_368"},{"name":"value","in":"query","required":false,"example":"pfOrg","schemaId":"schema_369"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v2/positions","href":"positions/getpositions","openApiOperationId":"getPositions","summary":"Positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of positions for the given parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position"]}},"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid position level: Value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LE: legal entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORG: organization"},"children":[]}]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No position data for the given query."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found: Given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request was malformed."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position"]}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/positions/getpositions"}],"panels":[]}]},"httpPath":"/v2/positions"},{"label":"Positions by value date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/positions/getpositionsvaluedate","routeSlug":"/openapi/integral-api-reference/rest/positions/getpositionsvaluedate","metadata":{"seo":{"title":"Positions by value date","description":"Get open positions by value date. All query parameters are optional. If no parameters are specified, all open positions for the logged-in user and specified value date are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPositionsValueDate","name":"Positions by value date","isWebhook":false,"pointer":"/paths/~1v2~1positions~1{valueDate}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Positions by value date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get open positions by value date. All query parameters are optional. If no parameters are specified, all open positions for the logged-in user and specified value date are returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"valueDate","in":"path","schemaId":"schema_371","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1positions~1{valueDate}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"symbol","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"level","in":"query","schemaId":"schema_368","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. The level at which the position is calculated, case sensitive:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": legal entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": organization"},"children":[]}]}]}]}],"examples":{"user":{"summary":"User level","value":"USER"},"legalEntity":{"summary":"Legal-entity level","value":"LE"},"organization":{"summary":"Organization level","value":"ORG"}}},{"name":"value","in":"query","schemaId":"schema_369","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. The ID of a specific org, legal entity, or user (depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1positions~1{valueDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/positions/{valueDate}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"valueDate","in":"path","required":true,"example":"2022-03-11","schemaId":"schema_371"}],"query":[{"name":"symbol","in":"query","required":false,"example":"EUR/USD","schemaId":"schema_336"},{"name":"level","in":"query","required":false,"example":"USER","schemaId":"schema_368"},{"name":"value","in":"query","required":false,"example":"pfOrg","schemaId":"schema_369"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v2/positions/{valueDate}","href":"positions/getpositionsvaluedate","openApiOperationId":"getPositionsValueDate","summary":"Positions by value date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of positions for the given parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position"]}},"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid position level: Value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LE: legal entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORG: organization"},"children":[]}]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No position data for the given query."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found: Given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request was malformed."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1positions~1{valueDate}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position"]}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/positions/getpositionsvaluedate"}],"panels":[]}]},"httpPath":"/v2/positions/{valueDate}"}],"content":{"contentType":"group","meta":{"name":"Positions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Positions","showPageActions":true},{"nodeType":"markdoc","content":"Get open positions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/positions","summary":"Positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/positions/getpositions","deprecated":false},{"title":"/v2/positions/{valueDate}","summary":"Positions by value date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/positions/getpositionsvaluedate","deprecated":false}]}]}]}]}},{"type":"group","label":"Custody","link":"/openapi/integral-api-reference/rest/custody","routeSlug":"/openapi/integral-api-reference/rest/custody","items":[{"type":"link","label":"Access and dashboard","link":"/openapi/integral-api-reference/rest/custody/access-and-dashboard","routeSlug":"/openapi/integral-api-reference/rest/custody/access-and-dashboard","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Access and dashboard"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"custody/access-and-dashboard"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access and dashboard"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brokers can access the Custody system via the following UAT URL: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://crdnet-uat.codexnetwork.org/auth/login"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://crdnet-uat.codexnetwork.org/auth/login"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After logging in, brokers can view all connected LP and exchange accounts that support balance retrieval. The dashboard allows users to view aggregated balances and group them by exchange account."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"API authentication","link":"/openapi/integral-api-reference/rest/custody/api-authentication","routeSlug":"/openapi/integral-api-reference/rest/custody/api-authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"custody/api-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Integral Custody server provides balance APIs secured by HMAC-based authentication. Users can generate their own credentials within their Profile Settings. Please note that the API Secret is displayed only at the time of key creation and cannot be retrieved later."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Get deposit address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/custody/getdepositaddress","routeSlug":"/openapi/integral-api-reference/rest/custody/getdepositaddress","metadata":{"seo":{"title":"Get deposit address","description":"Get the deposit address on a native blockchain which is used to link deposits to specific customer wallets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDepositAddress","name":"Get deposit address","isWebhook":false,"pointer":"/paths/~1custody~1v2~1deposit~1address/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get deposit address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the deposit address on a native blockchain which is used to link deposits to specific customer wallets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_372","description":"Digital asset code.","required":true},{"name":"network","in":"query","schemaId":"schema_373","description":"Chain name / network"}],"pointer":"/paths/~1custody~1v2~1deposit~1address/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/deposit/address","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":true,"schemaId":"schema_372"},{"name":"network","in":"query","required":false,"schemaId":"schema_373"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/custody/v2/deposit/address","href":"custody/getdepositaddress","openApiOperationId":"getDepositAddress","summary":"Get deposit address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/depositAddressResponse"}},"schemaId":"components/schemas/depositAddressResponse","headers":{"X-Rate-Limit":{"description":"Calls per hour allowed by the user","schema":{"type":"integer","format":"int32"}}},"headerSchemaId":"schema_374"},{"code":"400","description":"Invalid or unsupported currency or network"}],"pointer":"/paths/~1custody~1v2~1deposit~1address/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/depositAddressResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/depositAddressResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custody/getdepositaddress"}],"panels":[]}]},"httpPath":"/custody/v2/deposit/address"},{"label":"Query deposit history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/custody/getdeposithistory","routeSlug":"/openapi/integral-api-reference/rest/custody/getdeposithistory","metadata":{"seo":{"title":"Query deposit history","description":"Query the deposit history for current customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDepositHistory","name":"Query deposit history","isWebhook":false,"pointer":"/paths/~1custody~1v2~1deposit~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query deposit history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query the deposit history for current customer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_372","description":"Digital asset code."},{"name":"txId","in":"query","schemaId":"schema_373","description":"External blockchain transaction ID."},{"name":"status","in":"query","schemaId":"schema_375","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer that indicates the status of the deposit transactions to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = successful"},"children":[]}]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_376","description":"Number of records to return. If your query results in more than 1000 transactions, only the first 1000 are returned."},{"name":"startTime","in":"query","schemaId":"schema_377","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of time period of deposits to return based on the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix time in milliseconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and do not specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endTime","in":"query","schemaId":"schema_377","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of time period of deposits to return based on the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix time in milliseconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is specified, you must also specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and do not specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used."},"children":[]}]}]}]}],"pointer":"/paths/~1custody~1v2~1deposit~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/deposit/history","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":false,"schemaId":"schema_372"},{"name":"txId","in":"query","required":false,"schemaId":"schema_373"},{"name":"status","in":"query","required":false,"schemaId":"schema_375"},{"name":"limit","in":"query","required":false,"schemaId":"schema_376"},{"name":"startTime","in":"query","required":false,"schemaId":"schema_377"},{"name":"endTime","in":"query","required":false,"schemaId":"schema_377"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/custody/v2/deposit/history","href":"custody/getdeposithistory","openApiOperationId":"getDepositHistory","summary":"Query deposit history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378","headers":{"X-Rate-Limit":{"description":"Calls per hour allowed by the user","schema":{"type":"integer","format":"int32"}}},"headerSchemaId":"schema_374"},{"code":"400","description":"Invalid or unsupported currency or network"}],"pointer":"/paths/~1custody~1v2~1deposit~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custody/getdeposithistory"}],"panels":[]}]},"httpPath":"/custody/v2/deposit/history"},{"label":"Initiate withdrawal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/custody/createwithdrawal","routeSlug":"/openapi/integral-api-reference/rest/custody/createwithdrawal","metadata":{"seo":{"title":"Initiate withdrawal","description":"Withdraw a digital asset from a customer wallet."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWithdrawal","name":"Initiate withdrawal","isWebhook":false,"pointer":"/paths/~1custody~1v2~1withdraw~1apply/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate withdrawal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Withdraw a digital asset from a customer wallet."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_372","description":"Digital asset code.","required":true},{"name":"network","in":"query","schemaId":"schema_373","description":"Chain name / network","required":true},{"name":"address","in":"query","schemaId":"schema_373","description":"Withdrawal address","required":true},{"name":"tag","in":"query","schemaId":"schema_373","description":"Withdrawal address tag / memo"},{"name":"amount","in":"query","schemaId":"schema_379","description":"Withdrawal amount","required":true},{"name":"name","in":"query","schemaId":"schema_373","description":"Withdrawal address name"}],"pointer":"/paths/~1custody~1v2~1withdraw~1apply/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custody/v2/withdraw/apply","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":true,"schemaId":"schema_372"},{"name":"network","in":"query","required":true,"schemaId":"schema_373"},{"name":"address","in":"query","required":true,"schemaId":"schema_373"},{"name":"tag","in":"query","required":false,"schemaId":"schema_373"},{"name":"amount","in":"query","required":true,"schemaId":"schema_379"},{"name":"name","in":"query","required":false,"schemaId":"schema_373"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/custody/v2/withdraw/apply","href":"custody/createwithdrawal","openApiOperationId":"createWithdrawal","summary":"Initiate withdrawal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/withdrawResponse"}},"schemaId":"components/schemas/withdrawResponse","headers":{"X-Rate-Limit":{"description":"calls per hour allowed by the user","schema":{"type":"integer","format":"int32"}}},"headerSchemaId":"schema_380"},{"code":"400","description":"Invalid or unsupported currency or network"}],"pointer":"/paths/~1custody~1v2~1withdraw~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/withdrawResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/withdrawResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custody/createwithdrawal"}],"panels":[]}]},"httpPath":"/custody/v2/withdraw/apply"},{"label":"Query withdrawal history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/custody/getwithdrawhistory","routeSlug":"/openapi/integral-api-reference/rest/custody/getwithdrawhistory","metadata":{"seo":{"title":"Query withdrawal history","description":"Query withdrawal transaction history for current user. Transactions are sorted by createdTime."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWithdrawHistory","name":"Query withdrawal history","isWebhook":false,"pointer":"/paths/~1custody~1v2~1withdraw~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query withdrawal history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query withdrawal transaction history for current user. Transactions are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_372","description":"Digital asset code."},{"name":"txId","in":"query","schemaId":"schema_381","description":"External blockchain transaction ID."},{"name":"status","in":"query","schemaId":"schema_375","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer that indicates the status of the withdrawal transactions to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = email sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = awaiting approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 = failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 = completed"},"children":[]}]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_376","description":"Number of records to return. Max value of 1000. If your query results in more than 1000 transactions, only the first 1000 are returned."},{"name":"startTime","in":"query","schemaId":"schema_377","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of time period of withdrawals to return based on the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix time in milliseconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and do not specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endTime","in":"query","schemaId":"schema_377","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of time period of withdrawals to return based on the transaction's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix time in milliseconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is specified, you must also specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and do not specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used."},"children":[]}]}]}]}],"pointer":"/paths/~1custody~1v2~1withdraw~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/withdraw/history","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":false,"schemaId":"schema_372"},{"name":"txId","in":"query","required":false,"schemaId":"schema_381"},{"name":"status","in":"query","required":false,"schemaId":"schema_375"},{"name":"limit","in":"query","required":false,"schemaId":"schema_376"},{"name":"startTime","in":"query","required":false,"schemaId":"schema_377"},{"name":"endTime","in":"query","required":false,"schemaId":"schema_377"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/custody/v2/withdraw/history","href":"custody/getwithdrawhistory","openApiOperationId":"getWithdrawHistory","summary":"Query withdrawal history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","headers":{"X-Rate-Limit":{"description":"Calls per hour allowed by the user","schema":{"type":"integer","format":"int32"}}},"headerSchemaId":"schema_374"},{"code":"400","description":"Invalid or unsupported currency or network"}],"pointer":"/paths/~1custody~1v2~1withdraw~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custody/getwithdrawhistory"}],"panels":[]}]},"httpPath":"/custody/v2/withdraw/history"}],"content":{"contentType":"group","meta":{"name":"Custody"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custody","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integral’s Custody system connects to liquidity providers (LPs) and exchanges to retrieve balance data on behalf of brokers. This data is synchronized with Integral trading systems via active polling (every 15 seconds) or WebSockets for near real-time updates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custody/v2/deposit/address","summary":"Get deposit address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custody/getdepositaddress","deprecated":false},{"title":"/custody/v2/deposit/history","summary":"Query deposit history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custody/getdeposithistory","deprecated":false},{"title":"/custody/v2/withdraw/apply","summary":"Initiate withdrawal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custody/createwithdrawal","deprecated":false},{"title":"/custody/v2/withdraw/history","summary":"Query withdrawal history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custody/getwithdrawhistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts","link":"/openapi/integral-api-reference/rest/accounts","routeSlug":"/openapi/integral-api-reference/rest/accounts","items":[{"label":"Get account balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/accounts/getaccountbalance","routeSlug":"/openapi/integral-api-reference/rest/accounts/getaccountbalance","metadata":{"seo":{"title":"Get account balance","description":"Get account balances in a specific asset or all assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountBalance","name":"Get account balance","isWebhook":false,"pointer":"/paths/~1custody~1v2~1account~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get account balances in a specific asset or all assets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"custodyOrg","in":"query","schemaId":"schema_373","description":"Custody organization name","required":true},{"name":"currency","in":"query","schemaId":"schema_372","description":"Currency code. Omit this parameter to get balances for all currencies."}],"pointer":"/paths/~1custody~1v2~1account~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/account/balances","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"custodyOrg","in":"query","required":true,"schemaId":"schema_373"},{"name":"currency","in":"query","required":false,"schemaId":"schema_372"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/custody/v2/account/balances","href":"accounts/getaccountbalance","openApiOperationId":"getAccountBalance","summary":"Get account balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation. If there are no balances, an empty array is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balanceResponse","exampleIds":["paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance","paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance"]}},"schemaId":"components/schemas/balanceResponse","exampleIds":["paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance","paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance"]},{"code":"404","description":"Invalid or unsupported currency"}],"pointer":"/paths/~1custody~1v2~1account~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/balanceResponse","exampleIds":["paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance","paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balanceResponse","exampleIds":["paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance","paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/getaccountbalance"}],"panels":[]}]},"httpPath":"/custody/v2/account/balances"},{"label":"Get broker account balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/accounts/getaccountbalancebroker","routeSlug":"/openapi/integral-api-reference/rest/accounts/getaccountbalancebroker","metadata":{"seo":{"title":"Get broker account balances","description":"Get account balances for a broker in all assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountBalanceBroker","name":"Get broker account balances","isWebhook":false,"pointer":"/paths/~1custody~1v2~1broker~1account~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get broker account balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get account balances for a broker in all assets."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"accounts/getaccountbalancebroker/request/sample-script","deepLinkHash":"/accounts/getaccountbalancebroker#accounts/getaccountbalancebroker/request/sample-script"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sample script"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following shell script demonstrates how to authenticate and retrieve account balances from the API. To execute this request, you will need the following credentials:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Broker Org Name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Your organization's identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Your unique access key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECRET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The secret key associated with your API Key (used for signing)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API requires an HMAC signature within the Authorization header. The script below calculates this signature and formats the header as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: hmac username=\"${API_KEY}\", algorithm=\"hmac-sha256\", headers=\"date request-line\", signature=\"${SIGNATURE}\""},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sample shell script"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"# Variables\nURL_PATH=\"/custody/api/broker/account/balances\"\nQUERY=\"org=<broker_org_name>&isOrgLP=false\"\nAPI_KEY=\"UGmfhBAoXTePWcxtljL0VSAiHTNAW3Uc\"\nSECRET=\"<secret>\"\n\n# RFC 1123 date in GMT\nDATE=$(LC_ALL=C date -u +\"%a, %d %b %Y %H:%M:%S GMT\")\n\n# Build signing string EXACTLY as Kong expects\nSIGNING_STRING=\"date: ${DATE}\\nGET ${URL_PATH}?${QUERY} HTTP/1.1\"\n\n# Generate HMAC signature (base64)\nSIGNATURE=$(printf \"%b\" \"$SIGNING_STRING\" | openssl dgst -sha256 -hmac \"$SECRET\" -binary | base64)\n\n# Show for debugging\necho \"Signing String:\"\nprintf \"%b\\n\" \"$SIGNING_STRING\"\necho \"\"\necho \"Signature: $SIGNATURE\"\necho \"\"\n\n# Execute request\ncurl -v \"https://crdnet-uat.codexnetwork.org${URL_PATH}?${QUERY}\" \\\n-H \"Date: ${DATE}\" \\\n-H \"Authorization: hmac username=\\\"${API_KEY}\\\", algorithm=\\\"hmac-sha256\\\", \\\n    headers=\\\"date request-line\\\", signature=\\\"${SIGNATURE}\\\"\"\n","language":"shell"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"# Variables\nURL_PATH=\"/custody/api/broker/account/balances\"\nQUERY=\"org=<broker_org_name>&isOrgLP=false\"\nAPI_KEY=\"UGmfhBAoXTePWcxtljL0VSAiHTNAW3Uc\"\nSECRET=\"<secret>\"\n\n# RFC 1123 date in GMT\nDATE=$(LC_ALL=C date -u +\"%a, %d %b %Y %H:%M:%S GMT\")\n\n# Build signing string EXACTLY as Kong expects\nSIGNING_STRING=\"date: ${DATE}\\nGET ${URL_PATH}?${QUERY} HTTP/1.1\"\n\n# Generate HMAC signature (base64)\nSIGNATURE=$(printf \"%b\" \"$SIGNING_STRING\" | openssl dgst -sha256 -hmac \"$SECRET\" -binary | base64)\n\n# Show for debugging\necho \"Signing String:\"\nprintf \"%b\\n\" \"$SIGNING_STRING\"\necho \"\"\necho \"Signature: $SIGNATURE\"\necho \"\"\n\n# Execute request\ncurl -v \"https://crdnet-uat.codexnetwork.org${URL_PATH}?${QUERY}\" \\\n-H \"Date: ${DATE}\" \\\n-H \"Authorization: hmac username=\\\"${API_KEY}\\\", algorithm=\\\"hmac-sha256\\\", \\\n    headers=\\\"date request-line\\\", signature=\\\"${SIGNATURE}\\\"\"\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"orgName","in":"query","schemaId":"schema_373","description":"Custody / liquidity provider (LP) / exchange / customer organization name","required":true},{"name":"isLP","in":"query","schemaId":"schema_383","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the organization is an LP ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or customer ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1custody~1v2~1broker~1account~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/broker/account/balances","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"orgName","in":"query","required":true,"schemaId":"schema_373"},{"name":"isLP","in":"query","required":true,"schemaId":"schema_383"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/custody/v2/broker/account/balances","href":"accounts/getaccountbalancebroker","openApiOperationId":"getAccountBalanceBroker","summary":"Get broker account balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation. If there are no balances, an empty array is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brokerBalanceResponse","exampleIds":["paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances"]}},"schemaId":"components/schemas/brokerBalanceResponse","exampleIds":["paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances"]},{"code":"404","description":"Invalid or unsupported currency"}],"pointer":"/paths/~1custody~1v2~1broker~1account~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/brokerBalanceResponse","exampleIds":["paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brokerBalanceResponse","exampleIds":["paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/getaccountbalancebroker"}],"panels":[]}]},"httpPath":"/custody/v2/broker/account/balances"},{"label":"Update broker account balance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/accounts/updatebrokeraccountbalance","routeSlug":"/openapi/integral-api-reference/rest/accounts/updatebrokeraccountbalance","metadata":{"seo":{"title":"Update broker account balance","description":"Update broker account balances in a specific asset or all assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBrokerAccountBalance","name":"Update broker account balance","isWebhook":false,"pointer":"/paths/~1custody~1v2~1broker~1account~1balances/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update broker account balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update broker account balances in a specific asset or all assets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/brokerBalanceUpdateRequest"}},"schemaId":"components/schemas/brokerBalanceUpdateRequest","pointer":"/paths/~1custody~1v2~1broker~1account~1balances/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custody/v2/broker/account/balances","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/brokerBalanceUpdateRequest"}},"responseCodes":["default"],"pointer":"/custody/v2/broker/account/balances","href":"accounts/updatebrokeraccountbalance","openApiOperationId":"updateBrokerAccountBalance","summary":"Update broker account balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/brokerBalanceUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/brokerBalanceUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"default","description":"Success / Failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brokerBalanceUpdateResponse"}},"schemaId":"components/schemas/brokerBalanceUpdateResponse"}],"pointer":"/paths/~1custody~1v2~1broker~1account~1balances/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"default","schemaId":"components/schemas/brokerBalanceUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brokerBalanceUpdateResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/updatebrokeraccountbalance"}],"panels":[]}]},"httpPath":"/custody/v2/broker/account/balances"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account-related data and operations, such as checking balances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integral’s system connects to liquidity providers (LPs) and exchanges to retrieve balance data on behalf of brokers. This data is synchronized with Integral trading systems via active polling (every 15 seconds) or WebSockets for near real-time updates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custody/v2/account/balances","summary":"Get account balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/getaccountbalance","deprecated":false},{"title":"/custody/v2/broker/account/balances","summary":"Get broker account balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/getaccountbalancebroker","deprecated":false},{"title":"/custody/v2/broker/account/balances","summary":"Update broker account balance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounts/updatebrokeraccountbalance","deprecated":false}]}]}]}]}},{"type":"group","label":"STP download","link":"/openapi/integral-api-reference/rest/stp-download","routeSlug":"/openapi/integral-api-reference/rest/stp-download","items":[{"label":"Get done trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/stp-download/gettrades","routeSlug":"/openapi/integral-api-reference/rest/stp-download/gettrades","metadata":{"seo":{"title":"Get done trades","description":"Get executed trades that have not been downloaded before. The default maximum number of trades returned is determined by the server. You should poll this endpoint until you receive an empty response indicating that there are no remaining executed trades available for STP download."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrades","name":"Get done trades","isWebhook":false,"pointer":"/paths/~1v2~1trades~1stp~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get done trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get executed trades that have not been downloaded before. The default maximum number of trades returned is determined by the server. You should poll this endpoint until you receive an empty response indicating that there are no remaining executed trades available for STP download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get trades that have been previously downloaded, you must first call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/resend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepare trades to resend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"maxCount","in":"query","schemaId":"schema_384","description":"Max number of trades to download. If not specified, the default max number of trades is used (currently 50)."}],"pointer":"/paths/~1v2~1trades~1stp~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/trades/stp/messages","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"maxCount","in":"query","required":false,"example":20,"schemaId":"schema_384"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v2/trades/stp/messages","href":"stp-download/gettrades","openApiOperationId":"getTrades","summary":"Get done trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of executed trades. An empty response indicates no executed trades available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385","exampleIds":["paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend"]}},"schemaId":"schema_385","exampleIds":["paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend"]},{"code":"404","description":"Your request was malformed."},{"code":"500","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a serious error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop trading immediately and contact Business Support to resolve the issue."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1trades~1stp~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","exampleIds":["paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385","exampleIds":["paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright","paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend"]}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stp-download/gettrades"}],"panels":[]}]},"httpPath":"/v2/trades/stp/messages"},{"label":"Prepare trades to resend","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/stp-download/resend","routeSlug":"/openapi/integral-api-reference/rest/stp-download/resend","metadata":{"seo":{"title":"Prepare trades to resend","description":"Set previously downloaded trades with tradeDate within the specified date range as eligible for download. You must then call the Get trades endpoint to download the trades. The event attribute on previously downloaded trades is always set to RESEND."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resend","name":"Prepare trades to resend","isWebhook":false,"pointer":"/paths/~1v2~1trades~1stp~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prepare trades to resend","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set previously downloaded trades with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the specified date range as eligible for download. You must then call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getTrades"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get trades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to download the trades. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute on previously downloaded trades is always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESEND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1v2~1trades~1stp~1resend/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/trades/stp/resend","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200","404"],"pointer":"/v2/trades/stp/resend","href":"stp-download/resend","openApiOperationId":"resend","summary":"Prepare trades to resend"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful request. You must call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getTrades"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get trades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to download the trades."},"children":[]}]}]}]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1trades~1stp~1resend/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stp-download/resend"}],"panels":[]}]},"httpPath":"/v2/trades/stp/resend"}],"content":{"contentType":"group","meta":{"name":"STP download"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"STP download","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get executed trades that have not been downloaded before."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get trades that have been previously downloaded, you must first call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/resend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepare trades to resend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/trades/stp/messages","summary":"Get done trades","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stp-download/gettrades","deprecated":false},{"title":"/v2/trades/stp/resend","summary":"Prepare trades to resend","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stp-download/resend","deprecated":false}]}]}]}]}},{"type":"group","label":"Reference data","link":"/openapi/integral-api-reference/rest/reference-data","routeSlug":"/openapi/integral-api-reference/rest/reference-data","items":[{"label":"Get list of assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/reference-data/getassetdetail","routeSlug":"/openapi/integral-api-reference/rest/reference-data/getassetdetail","metadata":{"seo":{"title":"Get list of assets","description":"List of all assets with details, such as whether you can deposit or withdraw, minimum withdrawal amount, and withdrawal fee. Use the currency parameter to get details of a specific asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetDetail","name":"Get list of assets","isWebhook":false,"pointer":"/paths/~1custody~1v2~1asset~1assetDetail/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of all assets with details, such as whether you can deposit or withdraw, minimum withdrawal amount, and withdrawal fee. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get details of a specific asset."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_387","description":"Digital asset code."}],"pointer":"/paths/~1custody~1v2~1asset~1assetDetail/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custody/v2/asset/assetDetail","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":false,"example":"BTC","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/custody/v2/asset/assetDetail","href":"reference-data/getassetdetail","openApiOperationId":"getAssetDetail","summary":"Get list of assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of asset details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"400","description":"Invalid or unsupported currency or network"}],"pointer":"/paths/~1custody~1v2~1asset~1assetDetail/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getassetdetail"}],"panels":[]}]},"httpPath":"/custody/v2/asset/assetDetail"},{"label":"Get instrument properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/reference-data/getrefdatacurrencies","routeSlug":"/openapi/integral-api-reference/rest/reference-data/getrefdatacurrencies","metadata":{"seo":{"title":"Get instrument properties","description":"Basic quoting convention properties of an instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefDataCurrencies","name":"Get instrument properties","isWebhook":false,"pointer":"/paths/~1v2~1refdata~1currencies~1{instrument}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Basic quoting convention properties of an instrument"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrument","in":"path","schemaId":"schema_389","description":"No default value. Typically the three-character ISO code.","required":true}],"pointer":"/paths/~1v2~1refdata~1currencies~1{instrument}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/refdata/currencies/{instrument}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"instrument","in":"path","required":true,"example":"USD","schemaId":"schema_389"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/refdata/currencies/{instrument}","href":"reference-data/getrefdatacurrencies","openApiOperationId":"getRefDataCurrencies","summary":"Get instrument properties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Basic quoting convention properties of the instrument.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/instrument","exampleIds":["paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency"]}},"schemaId":"components/schemas/instrument","exampleIds":["paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found: Given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request was malformed."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1refdata~1currencies~1{instrument}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/instrument","exampleIds":["paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/instrument","exampleIds":["paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getrefdatacurrencies"}],"panels":[]}]},"httpPath":"/v2/refdata/currencies/{instrument}"},{"label":"Get symbol properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/reference-data/getrefdatasymbols","routeSlug":"/openapi/integral-api-reference/rest/reference-data/getrefdatasymbols","metadata":{"seo":{"title":"Get symbol properties","description":"Basic quoting convention properties of a symbol"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefDataSymbols","name":"Get symbol properties","isWebhook":false,"pointer":"/paths/~1v2~1refdata~1symbols~1{symbol}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get symbol properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Basic quoting convention properties of a symbol"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"symbol","in":"path","schemaId":"schema_390","description":"No default value. Typically the joined IDs of the base and term instruments.","required":true}],"pointer":"/paths/~1v2~1refdata~1symbols~1{symbol}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/refdata/symbols/{symbol}","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"symbol","in":"path","required":true,"example":"EURUSD","schemaId":"schema_390"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/refdata/symbols/{symbol}","href":"reference-data/getrefdatasymbols","openApiOperationId":"getRefDataSymbols","summary":"Get symbol properties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Basic quoting convention properties of the symbol.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/symbol","exampleIds":["paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair"]}},"schemaId":"components/schemas/symbol","exampleIds":["paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found: Given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request was malformed."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1refdata~1symbols~1{symbol}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/symbol","exampleIds":["paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/symbol","exampleIds":["paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getrefdatasymbols"}],"panels":[]}]},"httpPath":"/v2/refdata/symbols/{symbol}"},{"label":"Get all symbols and instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/integral-api-reference/rest/reference-data/getrefdatasymbolslist","routeSlug":"/openapi/integral-api-reference/rest/reference-data/getrefdatasymbolslist","metadata":{"seo":{"title":"Get all symbols and instruments","description":"Depending on the query parameter, returns:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefDataSymbolsList","name":"Get all symbols and instruments","isWebhook":false,"pointer":"/paths/~1v2~1refdata~1currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all symbols and instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the query parameter, returns:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All symbols supported in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All instruments supported by the requesting organization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SSO_TOKEN","scopes":[],"type":"apiKey","in":"header","paramName":"SSO_TOKEN","description":"API key to authorize requests."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tradables","in":"query","schemaId":"schema_383","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get all instruments supported by the requesting organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit to get all symbols supported in the system."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1refdata~1currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/refdata/currencies","servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"tradables","in":"query","required":false,"schemaId":"schema_383"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SSO_TOKEN","type":"apiKey","name":"SSO_TOKEN","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/refdata/currencies","href":"reference-data/getrefdatasymbolslist","openApiOperationId":"getRefDataSymbolsList","summary":"Get all symbols and instruments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of all supported symbols in the system.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391","exampleIds":["paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList","paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList"]}},"schemaId":"schema_391","exampleIds":["paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList","paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList"]},{"code":"404","description":"Your request was malformed."}],"pointer":"/paths/~1v2~1refdata~1currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_391","exampleIds":["paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList","paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391","exampleIds":["paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList","paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getrefdatasymbolslist"}],"panels":[]}]},"httpPath":"/v2/refdata/currencies"}],"content":{"contentType":"group","meta":{"name":"Reference data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference data","showPageActions":true},{"nodeType":"markdoc","content":"Fundamental business data (such as accounts, assets, instruments, and symbols) used by multiple endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custody/v2/asset/assetDetail","summary":"Get list of assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getassetdetail","deprecated":false},{"title":"/v2/refdata/currencies/{instrument}","summary":"Get instrument properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getrefdatacurrencies","deprecated":false},{"title":"/v2/refdata/symbols/{symbol}","summary":"Get symbol properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getrefdatasymbols","deprecated":false},{"title":"/v2/refdata/currencies","summary":"Get all symbols and instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getrefdatasymbolslist","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/tradeAmendRequest":{"id":"components/schemas/tradeAmendRequest","kind":"json-schema","title":"tradeAmendRequest","data":{"type":"object","properties":{"id":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the verified trade to amend."},"dealtAmount":{"type":"number","format":"double","minimum":0.01,"description":"New amount of the dealt instrument. Must be greater than zero and less than the maximum percentage change allowed, if configured."},"customerAccount":{"type":"string","minLength":1,"maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New customer’s legal entity ID."},"children":[]}]}]}]},"forwardPoints":{"type":"number","format":"double","description":"New forward points for a forward or NDF trade."},"spotRate":{"type":"number","format":"double","description":"New spot rate of the trade. Must be greater than zero."},"note":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any notes on the trade. These notes are sent via STP if the trade is eligible for STP (stp=true)."},"children":[]}]}]}]}},"required":["id"]}},"components/schemas/tradeRollRequest":{"id":"components/schemas/tradeRollRequest","kind":"json-schema","title":"tradeRollRequest","data":{"type":"object","properties":{"id":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the trade to roll."},"forwardPoints":{"type":"number","format":"double","default":0,"description":"Forward points for the rolled trade."},"valueDate":{"type":"string","minLength":10,"maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New value date for the rolled trade in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingDate":{"type":"string","minLength":10,"maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New fixing date for the rolled NDF trade in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required for trades in non-deliverable instruments."},"children":[]}]}]}]},"note":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any notes on the trade. These notes are sent via STP if the trade is eligible for STP (stp=true)."},"children":[]}]}]}]}},"required":["id","valueDate","forwardPoints"]}},"components/schemas/tradeAllocateRequest":{"id":"components/schemas/tradeAllocateRequest","kind":"json-schema","title":"tradeAllocateRequest","data":{"type":"object","properties":{"id":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the verified trade to divide into allocations."},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/tradeAllocateObject"}}},"required":["id","allocations"]}},"components/schemas/tradeAllocateObject":{"id":"components/schemas/tradeAllocateObject","kind":"json-schema","title":"tradeAllocateObject","data":{"type":"object","properties":{"referenceId":{"type":"string","minLength":1,"maxLength":120,"description":"Your reference ID for the allocation. Must be unique in the scope of the allocate request. Not validated for global uniqueness."},"allocationAmount":{"type":"number","format":"double","minimum":0.01,"description":"Size of the allocation."},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direction of the allocation from the perspective of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (case sensitive):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SELL"},"children":[]}]}]}]}]},"customerAccount":{"type":"string","minLength":1,"maxLength":30,"description":"The customer account of the allocation."},"note":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any notes on the allocation. These notes are sent via STP if the trade is eligible for STP (stp=true)."},"children":[]}]}]}]}},"required":["referenceId","allocationAmount","side","customerAccount"]}},"components/schemas/tradeCancelRequest":{"id":"components/schemas/tradeCancelRequest","kind":"json-schema","title":"tradeCancelRequest","data":{"type":"object","properties":{"tradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of trade to cancel. If specified, all other parameters are ignored."},"clientRequestId":{"type":"string","minLength":5,"maxLength":255,"description":"Your reference ID for the request to trade that resulted in the trades you want to cancel. Multiple trades may be cancelled."},"customerOrg":{"type":"string","minLength":1,"maxLength":60,"description":"ID of the customer organization on the trade."}},"required":["customerOrg"]}},"components/schemas/tradeCancelResponseTradeId":{"id":"components/schemas/tradeCancelResponseTradeId","kind":"json-schema","title":"tradeCancelResponseTradeId","data":{"type":"object","properties":{"customerOrg":{"type":"string","description":"ID of the customer organization on the cancelled trade."},"tradeId":{"type":"string","description":"ID of cancelled trade."}}}},"components/schemas/tradeCancelResponseClientRequestId":{"id":"components/schemas/tradeCancelResponseClientRequestId","kind":"json-schema","title":"tradeCancelResponseClientRequestId","data":{"type":"object","properties":{"customerOrg":{"type":"string","description":"Customer org that originated the cancelled trades."},"clientReferenceId":{"type":"string","description":"Trade request reference ID that originated the cancelled trades."},"trades":{"type":"array","items":{"type":"string","description":"IDs of cancelled trades."}}}}},"components/schemas/spotRate-TOB":{"id":"components/schemas/spotRate-TOB","kind":"json-schema","title":"spotRate-TOB","data":{"type":"object","properties":{"symbol":{"type":"string","maxLength":35},"bid":{"type":"number","format":"double"},"offer":{"type":"number","format":"double"},"bidLimit":{"type":"number","format":"double"},"offerLimit":{"type":"number","format":"double"},"time":{"type":"integer","format":"int64"},"rateId":{"type":"string","maxLength":255}}}},"components/schemas/spotRate-FULL":{"id":"components/schemas/spotRate-FULL","kind":"json-schema","title":"spotRate-FULL","data":{"type":"object","properties":{"symbol":{"type":"string","maxLength":35},"bid":{"type":"array","items":{"type":"number","format":"double"}},"offer":{"type":"array","items":{"type":"number","format":"double"}},"bidLimit":{"type":"array","items":{"type":"number","format":"double"}},"offerLimit":{"type":"array","items":{"type":"number","format":"double"}},"time":{"type":"integer","format":"int64"},"rateId":{"type":"string","maxLength":255}}}},"components/schemas/spotRate-RAW":{"id":"components/schemas/spotRate-RAW","kind":"json-schema","title":"spotRate-RAW","data":{"type":"object","properties":{"symbol":{"type":"string","maxLength":35},"bid":{"type":"array","items":{"type":"number","format":"double"}},"offer":{"type":"array","items":{"type":"number","format":"double"}},"bidLimit":{"type":"array","items":{"type":"number","format":"double"}},"offerLimit":{"type":"array","items":{"type":"number","format":"double"}},"bidProviders":{"type":"array","items":{"type":"string","maxLength":30}},"offerProviders":{"type":"array","items":{"type":"string","maxLength":30}},"time":{"type":"integer","format":"int64"},"rateId":{"type":"string","maxLength":255}}}},"components/schemas/marketDataSetResponse":{"id":"components/schemas/marketDataSetResponse","kind":"json-schema","title":"marketDataSetResponse","data":{"description":"Array of market data set objects.","type":"array","items":{"$ref":"#/components/schemas/marketDataSet"}}},"components/schemas/marketDataSet":{"id":"components/schemas/marketDataSet","kind":"json-schema","title":"marketDataSet","data":{"type":"object","properties":{"id":{"type":"string","maxLength":30,"description":"ID of market data set as defined in the Integral Pricing Engine."},"date":{"type":"string","nullable":true,"maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business date of the current market data set in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Applicable to end-of-day and fixed-period MDSs only. Null for regular MDSs."},"children":[]}]}]}]},"timeWindow":{"type":"string","nullable":true,"maxLength":53,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to fixed-period market data sets only. Time window when the rates in the market data set are active. Specified in 24-hour format from start time to end time ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hhmm-hhmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"name":{"type":"string","maxLength":50,"description":"Descriptive name of market data set."},"createdTime":{"type":"string","nullable":true,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Market data set creation date/time in the 24-hour format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"activationTime":{"type":"string","nullable":true,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to fixed-period market data sets only. Market data set activation date/time in the 24-hour format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"validUntil":{"type":"string","nullable":true,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to fixed-period market data sets only. Date/time the market data set is valid until in the 24-hour format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nextCreationTime":{"type":"string","nullable":true,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to fixed-period market data sets only. Date/time in 24-hour GMT the next market data set creation in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expirationTime":{"type":"string","nullable":true,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable to fixed-period market data sets only. Date/time at which the market data set expires in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The time is calculated by adding the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Frequency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the MDS configuration in the pricing engine to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activationTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"rates":{"type":"array","description":"Collection of rates.","items":{"type":"object","properties":{"status":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the currency pair and tenor in the market data set."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the currency pair and tenor has rates in the market data set."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the currency pair and tenor are valid, but there are no rates in the market data set. The HTTP response status code is still 200 (success) for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"rateId":{"type":"string","nullable":true,"maxLength":255,"description":"Unique rate identifier."},"tenor":{"type":"string","maxLength":20,"description":"Tenor from the request."},"currencyPair":{"type":"string","maxLength":25,"description":"Symbol from the request."},"bid":{"type":"number","format":"double","description":"Bid price."},"mid":{"type":"number","format":"double","nullable":true,"description":"Mid price."},"offer":{"type":"number","format":"double","description":"Offer price."},"baseCurrency":{"type":"string","maxLength":17,"description":"Base currency."},"termCurrency":{"type":"string","maxLength":17,"description":"Term currency."}}}}}}},"components/schemas/orderRequest":{"id":"components/schemas/orderRequest","kind":"json-schema","title":"orderRequest","data":{"type":"object","properties":{"coId":{"type":"string","maxLength":255,"description":"Client order ID assigned by the API user."},"rateId":{"type":"string","maxLength":255,"description":"Unique identifier for rate. Required for Previously Quoted Orders."},"type":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AtBest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Market"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopLimit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pegged"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Algo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (previously quoted)"},"children":[]}]}]}]}]},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the order placer’s perspective and always for the dealt currency."},"children":[]}]}]}]},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"size":{"type":"number","format":"double","description":"Order amount."},"currency":{"type":"string","maxLength":17,"description":"Dealt currency."},"price":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order’s requested limit price."},"children":[]}]}]}]},"priceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional for At Best orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]}]}]},"timeInForce":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GTC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required for at-best orders)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GTT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiryTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAY"},"children":[]}]}]}]}]},"org":{"type":"string","maxLength":30,"description":"Organization ID in Integral's system. If the order iss placed on behalf of another organization, this parameter contains the other organization's ID."},"account":{"type":"string","maxLength":30,"description":"The ID of the account (legal entity) for which the order iss placed. Required when placing orders on behalf of another organization."},"expiryTime":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiry time when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In seconds. Max value is one day (86399 seconds)."},"children":[]}]}]}]},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required for at-best orders."},"children":[]}]}]}]},"stopPrice":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order’s stop price (if any)."},"children":[]}]}]}]},"execFlags":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution strategy requested with order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BidTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stay on bid side"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MidTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mid price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OfferTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stay on offer side"},"children":[]}]}]}]}],"items":{"type":"string","maxLength":32}},"minQty":{"type":"number","format":"double","description":"Minimum fill size (if any) in dealt currency."},"maxShow":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the order visible to other market participants:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 (zero) or undefined: Hidden: Order is not visible to other customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Display: Full order amount visible to other customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Iceberg: Only the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxShow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" visible."},"children":[]}]}]}]}]},"targetStrategy":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) The algo or strategy of the order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Twap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LitSwitch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DarkSwitch"},"children":[]}]}]}]}]},"executionStartTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) Relative time at which the strategy should start execution specified in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS.sss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not specified, the strategy starts executing immediately."},"children":[]}]}]}]},"executionEndTime":{"type":"string","maxLength":32,"description":"(Algo) Absolute time in GMT at which the strategy should stop executing. If not specified, the order expires based on the value of its time in force."},"pegPriceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate the order is pegged to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pegged to mid rate."},"children":[]}]}]}]}]},"pegOffsetValue":{"type":"number","format":"double","description":"The amount in pips that is added to the price of the peg. Can be positive or negative."},"actionOnExpiry":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) Action taken at the end of the algo’s duration if there is an unfilled amount remaining. If not specified, the order is cancelled at expiration. NoAction, FillAtMarket, Twap"},"children":[]}]}]}]},"sliceSize":{"type":"number","format":"double","description":"(Algo) The fixed size of each slice."},"passiveTime":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) Time for which each slice rests in OCX RiskNet. Specified in milliseconds. Overrides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passiveTimeFactor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"passiveTimeFactorPercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) Determines how long each slice rests in OCX RiskNet, calculated as a percent of the actual slice interval. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not set"},"children":[]}]}]}]},"sliceInterval":{"type":"integer","format":"int64","description":"(Algo) Interval between slices in milliseconds. If the interval is fixed, this value is the interval duration. If the interval is randomized, this value is the upper boundary of random values."},"randomizeSliceSizePercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) The percentage range that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is randomized."},"children":[]}]}]}]},"randomizeSliceIntervalPercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) The percentage range that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceInterval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is randomized."},"children":[]}]}]}]},"tobRange":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Algo) If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" undefined, the slice size is this percentage of the top-of-book price size."},"children":[]}]}]}]},"customParameters":{"type":"object","maxLength":3500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of parameters that are unique to your organization. The number of parameters, their keynames, and values are defined by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Integral Technical Account Manager to enable and configure custom parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your custom parameters are included in API responses and in STP trade download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom parameters sent to Integral via API are stored in the database directly. No validation is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customParameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters, including all keys, values, and JSON syntax characters."},"children":[]}]}]}],"properties":{"keyName":{"type":"string","description":"The keyname of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."},"value":{"type":"string","description":"The value of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."}}}},"required":["coId","type","side","symbol","size","currency"]}},"components/schemas/order":{"id":"components/schemas/order","kind":"json-schema","title":"order","data":{"type":"object","properties":{"coId":{"type":"string","maxLength":255,"description":"Client order ID assigned by the API user."},"type":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AtBest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Market"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopLimit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pegged"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Algo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (previously quoted)"},"children":[]}]}]}]}]},"timeInForce":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GTC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOK"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GTT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAY"},"children":[]}]}]}]}]},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the order placer’s perspective and always for the dealt currency."},"children":[]}]}]}]},"currency":{"type":"string","maxLength":17,"description":"Dealt currency."},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"size":{"type":"number","format":"double","description":"Order amount."},"rateId":{"type":"string","maxLength":255,"description":"Unique identifier for rate. Required for Previously Quoted Orders."},"org":{"type":"string","maxLength":30,"description":"Organization ID in Integral's system. If the order was placed on behalf of another organization, this parameter contains the other organization's ID."},"account":{"type":"string","maxLength":30,"description":"The ID of the account (legal entity) for which the order was placed. Required when placing orders on behalf of another organization."},"price":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order’s limit price, if any."},"children":[]}]}]}]},"priceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional for At Best orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]}]}]},"expiryTime":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiry time when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=GTT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In seconds. Max value is one day (86399 seconds)."},"children":[]}]}]}]},"clientOrderTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time the order was submitted in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tradeChannel":{"type":"string","maxLength":128,"description":"The app or workflow that originated the order."},"targetStrategy":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Algo: The algo or strategy of the order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Twap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LitSwitch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DarkSwitch"},"children":[]}]}]}]}]},"originalCoId":{"type":"string","maxLength":255,"description":"The original client order ID of the order to be cancelled or replaced by this request."},"stopPrice":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order’s stop price (if any)."},"children":[]}]}]}]},"execFlags":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution strategy requested with order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BidTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stay on bid side"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MidTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mid price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OfferTrigger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stay on offer side"},"children":[]}]}]}]}],"items":{"type":"string","maxLength":32}},"minQty":{"type":"number","format":"double","description":"Minimum fill size (if any) in dealt currency."},"maxShow":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the order visible to other market participants:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 (zero) or undefined: Hidden: Order is not visible to other customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Display: Full order amount visible to other customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Iceberg: Only the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxShow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" visible."},"children":[]}]}]}]}]},"averagePrice":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average price of all fills so far. For orders and order types with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeInForce=FOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" such as at-best orders, this is the filled price."},"children":[]}]}]}]},"cumQty":{"type":"number","format":"double","description":"Total cumulative amount filled so far."},"orderId":{"type":"string","maxLength":60,"description":"Order ID assigned by Integral."},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tradeDate":{"type":"string","maxLength":20,"description":"Trade date of fill."},"executionType":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_FILL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_NEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE"},"children":[]}]}]}]}]},"leavesQty":{"type":"number","format":"double","description":"Unfilled amount as of the most recent fill."},"counterparty":{"type":"string","maxLength":30,"description":"Counterparty organization ID."},"counterPartyAccount":{"type":"string","maxLength":30,"description":"Counterparty legal entity ID."},"transactTime":{"type":"integer","format":"int64","description":"UTC time of last event on the order in milliseconds."},"userFullName":{"type":"string","maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fully qualified user name of order submitting user, including namespace and organization ID in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"@"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"namespace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"action":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelAll"},"children":[]}]}]}]}]},"status":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order received."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been entered and is working according to the order type and specified execution strategy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIALLY_FILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Trade done that does not completely fill the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Trade done that completely fills the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancel order request has been received and is in process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Order has been canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Order has been replaced with a new order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOPPED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Price matching has been paused for the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order has been rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order failed."},"children":[]}]}]}]}]},"reason":{"type":"string","maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the reason for failure or rejection. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a serious error. Stop trading immediately and contact Business Support to resolve the issue."},"children":[]}]}]}]},"customerId":{"type":"string","maxLength":30,"description":"Customer ID on whose behalf the order is placed."},"executionStartTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative time at which the strategy should start execution specified in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS.sss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not specified, the strategy starts executing immediately."},"children":[]}]}]}]},"executionEndTime":{"type":"string","maxLength":32,"description":"Absolute time in GMT at which the strategy should stop executing. If not specified, the order expires based on the value of its time in force."},"pegPriceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate the order is pegged to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pegged to mid rate."},"children":[]}]}]}]}]},"pegOffsetValue":{"type":"number","format":"double","description":"The amount in pips that is added to the price of the peg. Can be positive or negative."},"actionOnExpiry":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action taken at the end of the algo’s duration if there is an unfilled amount remaining. If not specified, the order is cancelled at expiration. NoAction, FillAtMarket, Twap"},"children":[]}]}]}]},"sliceSize":{"type":"number","format":"double","description":"The fixed size of each slice."},"passiveTime":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time for which each slice rests in OCX RiskNet. Specified in milliseconds. Overrides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passiveTimeFactor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"passiveTimeFactorPercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how long each slice rests in OCX RiskNet, calculated as a percent of the actual slice interval. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not set"},"children":[]}]}]}]},"sliceInterval":{"type":"integer","format":"int64","description":"Interval between slices in milliseconds. If the interval is fixed, this value is the interval duration. If the interval is randomized, this value is the upper boundary of random values."},"randomizeSliceSizePercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage range that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is randomized."},"children":[]}]}]}]},"randomizeSliceIntervalPercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage range that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceInterval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is randomized."},"children":[]}]}]}]},"tobRange":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sliceSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" undefined, the slice size is this percentage of the top-of-book price size."},"children":[]}]}]}]},"customParameters":{"type":"object","maxLength":3500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of parameters that are unique to your organization. The number of parameters, their keynames, and values are defined by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Integral Technical Account Manager to enable and configure custom parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your custom parameters are included in API responses and in STP trade download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom parameters sent to Integral via API are stored in the database directly. No validation is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customParameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters, including all keys, values, and JSON syntax characters."},"children":[]}]}]}],"properties":{"keyName":{"type":"string","description":"The keyname of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."},"value":{"type":"string","description":"The value of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."}}}},"required":["coId","type","timeInForce","side","currency","symbol","size"]}},"components/schemas/trade":{"id":"components/schemas/trade","kind":"json-schema","title":"trade","data":{"type":"object","properties":{"orderId":{"type":"string","maxLength":60,"description":"Order ID."},"tradeId":{"type":"string","maxLength":255,"description":"Integral trade ID."},"tradeType":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FwdFwd"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDFSwap"},"children":[]}]}]}]}]},"tenor":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade tenor:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": overnight (today)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tomorrow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot next (spot+1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of days after the current business date (for example, 1D, 2D, 10D)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of weeks after the current business date (for example, 1W, 2W, 3W)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of months after the current business date (for example, 1M, 2M, 3M)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of years after the current business date (for example, 1Y, 2Y, 3Y)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The next International Monetary Market (IMM) settlement date. IMM dates are the third Wednesday of the last month of every quarter (March, June, September, December). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in the next IMM date on or after the spot date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in two IMM dates after the spot date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (spot + IMM) for swaps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (tomorrow + IMM) for swaps"},"children":[]}]}]}]}]},"tradeDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the trade was initiated in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(NDF trades) Fixing date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingTenor":{"type":"string","maxLength":20,"description":"(NDF trades) Fixing tenor."},"executionTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time trade was done in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"maker":{"type":"boolean","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Maker (the deal was initiated by submitting a request or from working the balance on an outstanding order)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Taker (the deal was initiated by taking a dealable price in the app)."},"children":[]}]}]}]}]},"orderSide":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order from your perspective, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"status":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the trade when the message was created:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejected"},"children":[]}]}]}]}]},"rejectReason":{"type":"string","maxLength":128,"description":"The reason for trade rejection, if any."},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt instrument pair (currency, metal, energy, index, crypto), seven-character ISO code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"dealtIns":{"type":"string","maxLength":17,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt instrument, three-character ISO code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"dealtAmount":{"type":"number","format":"double","description":"Amount of the dealt instrument or near-leg instrument."},"settledAmount":{"type":"number","format":"double","description":"Amount of the settlement instrument."},"baseAmount":{"type":"number","format":"double","description":"Amount of base instrument."},"termAmount":{"type":"number","format":"double","description":"Amount of term instrument."},"spotRate":{"type":"number","format":"double","description":"Spot rate of the trade or near leg of the trade."},"rate":{"type":"number","format":"double","description":"All-in rate."},"orderType":{"type":"string","maxLength":20,"description":"Type of order."},"rateId":{"type":"string","maxLength":255,"description":"ID of the originating rate, if any."},"forwardPoints":{"type":"number","format":"double","description":"Forward points for outright trades and near leg of swaps."},"swapPoints":{"type":"number","format":"double","description":"Swap points, if any."},"customerAccount":{"type":"string","maxLength":30,"description":"Customer legal entity ID."},"customerOrg":{"type":"string","maxLength":30,"description":"Customer org ID."},"trader":{"type":"string","maxLength":30,"description":"Customer trader user who did the trade."},"counterparty":{"type":"string","maxLength":30,"description":"Counterparty ID."},"cptyLongName":{"type":"string","maxLength":128,"description":"Counterparty name."},"coverTradeIds":{"type":"array","description":"List of ID for trades that cover this trade, if any.","items":{"type":"string","maxLength":255}},"cptyTradeId":{"type":"string","maxLength":255,"description":"Trade ID assigned by counterparty.","nullable":true},"counterpartyAccount":{"type":"string","maxLength":30,"description":"Counterparty legal entity ID."},"channel":{"type":"string","maxLength":100,"description":"Workflow, app, and UI component that originated the request."},"farTenor":{"type":"string","maxLength":20,"description":"Far-leg tenor for swaps."},"farFixingTenor":{"type":"string","maxLength":20,"description":"Far-leg fixing tenor for NDF swaps."},"farFixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Far-leg fixing date for NDF swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"farValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Far-leg value date for swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"farSide":{"type":"string","maxLength":10,"description":"Side of the far leg for swaps."},"farRate":{"type":"number","format":"double","description":"Far-leg rate for swaps."},"farDealtAmount":{"type":"number","format":"double","description":"Far-leg amount in the dealt instrument for swaps."},"farSettledAmount":{"type":"number","format":"double","description":"Far-leg amount in the settlement instrument for swaps."},"farBaseAmount":{"type":"number","format":"double","description":"Far-leg amount in the base instrument for swap."},"farTermAmount":{"type":"number","format":"double","description":"Far-leg amount in the term instrument for swaps."},"farForwardPoints":{"type":"number","format":"double","description":"Far-leg forward points for swaps."},"counterpartyALEI":{"type":"string","maxLength":100,"description":"LEI code for counterpartyA."},"counterpartyBLEI":{"type":"string","maxLength":100,"description":"LEI code for counterpartyB."},"externalRequestId":{"type":"string","maxLength":255,"description":"The ID of the originating request for price from a system external to Integral."},"requestId":{"type":"string","maxLength":255,"description":"The ID of the originating request for price from Integral systems."},"portfolioId":{"type":"string","maxLength":100,"description":"Containing portfolio ID for batch trades and SSPs."},"benchmarkRate":{"type":"number","format":"double","description":"Reference benchmark rate."},"outright":{"type":"object","description":"Forward pricing info for the trade.","properties":{"forwardPoints":{"type":"number","format":"double","description":"Forward points."},"maturityDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maturity date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"spotRate":{"type":"number","format":"double","description":"Spot rate."},"fixingTenor":{"type":"string","maxLength":20,"description":"NDF fixing tenor, if any."},"tenor":{"type":"string","maxLength":20,"description":"Requested tenor, if any."},"fixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF fixing date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"farLegISIN":{"type":"string","maxLength":12,"description":"Far-leg International Securities Identification Number for multi-leg trades."},"nearLegISIN":{"type":"string","maxLength":12,"description":"Near-leg International Securities Identification Number for multi-leg trades."},"regulatory":{"type":"object","description":"An object containing regulatory information.","properties":{"orderSubmissionTime":{"type":"string","maxLength":32,"description":"Date and time of order submission."},"tradeExecutionTime":{"type":"string","maxLength":32,"description":"Date and time of trade execution."},"mtf":{"type":"boolean","description":"Whether or not the trade done in a multilateral trading facility."},"mtfVenue":{"type":"string","maxLength":30,"description":"ID of the MTF."},"investmentDecisionMaker":{"type":"string","maxLength":30,"description":"User ID of the investment decision maker."},"takerCapacity":{"type":"string","maxLength":10,"description":"Taker capacity represented by this trade."},"executingUser":{"type":"string","maxLength":30,"description":"ID of the executing user."},"executingOrg":{"type":"string","maxLength":30,"description":"ID of the executing organization."},"makerExecutingFirm":{"type":"string","maxLength":30,"description":"ID of the executing maker organization."},"takerExecutingFirm":{"type":"string","maxLength":30,"description":"ID of the executing taker organization."},"siExecution":{"type":"boolean","description":"Whether or not the trade done by a systemic internalizer."},"siVenue":{"type":"string","maxLength":30,"description":"The ID of the systemic internalizer venue."},"sft":{"type":"boolean","description":"Whether or not the trade is a securities financing transaction."},"npft":{"type":"boolean","description":"Whether or not the trade is a non-price forming transaction."},"preTradeWaiver":{"type":"string","maxLength":10,"description":"Pre-trade transparency waiver."},"postTradeDeferral":{"type":"string","maxLength":10,"description":"Post-trade deferral period."},"takerCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taker organization’s country code."},"children":[]}]}]}]},"makerCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maker organization’s country code."},"children":[]}]}]}]},"customerCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer’s country code."},"children":[]}]}]}]},"customerAccount":{"type":"string","maxLength":30,"description":"ID of the customer legal entity."},"counterpartyALEI":{"type":"string","maxLength":100,"description":"Counterparty A's Legal Entity Identifier for MiFID II."},"counterpartyBLEI":{"type":"string","maxLength":100,"description":"Counterparty B's Legal Entity Identifier for MiFID II."}}},"fees":{"type":"number","format":"double","description":"Fees on the trade, if any."},"initialSettledAmount":{"type":"number","format":"double","description":"The initial settled amount before any amendment."},"notes":{"type":"string","maxLength":255,"description":"Any notes on the order entered by the order submitting user."},"midMarket":{"type":"boolean","description":"Whether or not the trade was done at the mid-market rate."},"uti":{"type":"string","maxLength":150,"description":"The Unique Trade Identifier if the trade was done in a SEF."},"upi":{"type":"string","maxLength":50,"description":"The Unique Product Identifier if the trade was done in a SEF."},"isinLinkId":{"type":"string","maxLength":12,"description":"International Securities Identification Number link ID."},"customParameters":{"type":"object","maxLength":3500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of parameters that are unique to your organization. The number of parameters, their keynames, and values are defined by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Integral Technical Account Manager to enable and configure custom parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your custom parameters are included in API responses and in STP trade download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom parameters sent to Integral via API are stored in the database directly. No validation is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customParameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters, including all keys, values, and JSON syntax characters."},"children":[]}]}]}],"properties":{"keyName":{"type":"string","description":"The keyname of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."},"value":{"type":"string","description":"The value of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."}}}}}},"components/schemas/tradeExternal":{"id":"components/schemas/tradeExternal","kind":"json-schema","title":"tradeExternal","data":{"type":"object","properties":{"type":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]}]},"channel":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The workflow that originated the request. For reference in monitoring and reports. Values provided by Integral as applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = API/CreditEntry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = API/TradeEntry."},"children":[]}]}]}]}]},"clientRequestId":{"type":"string","maxLength":255,"description":"ID of the book trade request assigned by you. Returned in the success response so that you can associate the request and booked trade."},"referenceId":{"type":"string","maxLength":255,"description":"Free text for additional information and the ID, if any, assigned to the trade by the trade entry organization for their reference."},"note":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any notes on the trade. These notes are sent via STP if the trade is eligible for STP (stp=true)."},"children":[]}]}]}]},"counterpartyAccount":{"type":"string","maxLength":30,"description":"Maker account ID (legal entity)."},"counterparty":{"type":"string","maxLength":30,"description":"Counterparty organization ID."},"counterpartyTrader":{"type":"string","maxLength":30,"description":"Counterparty user ID. If not specified, the organization's default user as configured in the Integral system is used."},"customerAccount":{"type":"string","maxLength":30,"description":"Customer legal entity ID."},"customerOrg":{"type":"string","maxLength":30,"description":"Customer organization ID."},"trader":{"type":"string","maxLength":30,"description":"Customer user ID. If not specified, the default user of the customer organization is used."},"dealtIns":{"type":"string","maxLength":17,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dealt instrument, typically three-character ISO code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"dealtAmount":{"type":"number","format":"double","description":"Amount of the dealt instrument for the trade or near leg of swaps."},"baseAmount":{"type":"number","format":"double","description":"Amount of base instrument."},"termAmount":{"type":"number","format":"double","description":"Amount of term instrument."},"rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All-in rate to the precision of the currency pair’s quote convention. Trades with rates that are higher precision than allowed are rejected."},"children":[]}]}]}]},"side":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The side of the order from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerOrg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" perspective, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dealt instrument pair (currency, metal, energy, index, crypto), seven-character ISO code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"tradeDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the trade was initiated in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date for the trade or near leg of swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixing date for NDFs in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"spotRate":{"type":"number","format":"double","description":"Spot rate of the trade or near leg of the trade. Required for outrights, swaps, and NDFs."},"forwardPoints":{"type":"number","format":"double","default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for outrights, near leg of forward/forward swaps, and NDFs."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Forward points for outrights and near leg of forward/forward swaps."},"children":[]}]}]}]},"coverRate":{"type":"number","format":"double","description":"All-in rate at which the trade or near leg was hedged by the trader in the market."},"farSide":{"type":"string","maxLength":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (case sensitive), the side of the far-leg dealt currency from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerOrg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" perspective."},"children":[]}]}]}]},"farDealtAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Far-leg amount of the dealt instrument."},"children":[]}]}]}]},"farForwardPoints":{"type":"number","format":"double","default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Far-leg forward points."},"children":[]}]}]}]},"farRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Far-leg all-in rate."},"children":[]}]}]}]},"farValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value date for the far leg of swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be later than the near-leg value date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"farCoverRate":{"type":"number","format":"double","description":"All-in rate at which the far leg was hedged by the trader in the market."},"farFixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF far-leg fixing date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farFixingTenor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]},"bookName":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to FX Yield Manager. If FX Yield Manager is used to manage positions, this is the name of the book, if any, to which the trade is entered."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A = Cover trades, both customer trades and its cover trades."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B = Warehoused customer trades, FX Yield Manager hedging trades."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"empty = No-cover trades, unmanaged trades, desk trades."},"children":[]}]}]}]}]},"creditMode":{"type":"integer","format":"int32","default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the trade is considered for credit by Integral:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = CreditCheck: Trade request is rejected if credit is not available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = CreditOvershoot: Trade request is accepted even if credit is not available. Credit can overshoot the available limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = CreditIgnore: Credit is not taken."},"children":[]}]}]}]}]},"creditValuationAdjustment":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit valuation factor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerOrg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rateId":{"type":"string","maxLength":255,"description":"ID of the originating rate, if any."},"stp":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not included on the message, STP download is determined by the trade entry organization’s STP configuration. False overrides the organization’s settings and the trade is not sent via STP."},"children":[]}]}]}]}},"required":["type","channel","customerOrg","customerAccount","counterparty","counterpartyAccount","symbol","dealtIns","side","dealtAmount","rate","tradeDate","valueDate"]}},"components/schemas/tradeStp":{"id":"components/schemas/tradeStp","kind":"json-schema","title":"tradeStp","data":{"type":"object","required":["orderId","tradeId","coId","event","tradeType","tradeDate","valueDate","maker","side","status","symbol","currency","customerOrg","user","counterparty","executionTime","dealtAmount","baseAmount","termAmount","spotRate","rate"],"properties":{"orderId":{"type":"string","maxLength":60,"description":"Order ID. For cover trades, this is the cover order ID."},"tradeId":{"type":"string","maxLength":255,"description":"Integral trade ID."},"coId":{"type":"string","maxLength":255,"description":"Customer-supplied order ID."},"event":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the trade so you can decide how to treat the download."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Trade downloaded for the first time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESEND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A previously downloaded trade that is sent again with no changes"},"children":[]}]}]}]}]},"tradeType":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FwdFwd"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDFSwap"},"children":[]}]}]}]}]},"tradeDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the trade was initiated in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(NDF trades) Fixing date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fixingTenor":{"type":"string","maxLength":20,"description":"(NDF trades) Fixing tenor."},"maker":{"type":"boolean","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Maker (the deal was initiated by submitting a request or from working the balance on an outstanding order)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Taker (the deal was initiated by taking a dealable price in the app)."},"children":[]}]}]}]}]},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side of the order from the customer's perspective, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"status":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the trade when the message was created. STP returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" trades."},"children":[]}]}]}]},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt instrument pair (currency, metal, energy, index, crypto), for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rateId":{"type":"string","maxLength":255,"description":"May be omitted. ID of the originating rate for previously quoted (PQ) orders."},"customerAccount":{"type":"string","maxLength":30,"description":"Settlement code when available."},"customerOrg":{"type":"string","maxLength":30,"description":"Customer org ID."},"user":{"type":"string","maxLength":100,"description":"Full name of the user who entered the trade."},"counterparty":{"type":"string","maxLength":30,"description":"Counterparty ID."},"counterpartyLongName":{"type":"string","maxLength":255,"description":"Counterparty name."},"counterpartyTradeId":{"type":"string","maxLength":255,"description":"Trade ID assigned by counterparty.","nullable":true},"counterpartyAccount":{"type":"string","maxLength":30,"description":"Counterparty settlement code when available."},"channel":{"type":"string","maxLength":100,"description":"Workflow, app, and UI component that originated the request."},"channelCategory":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of trade origin or intent. Applicable when received by a taker."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GUI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HEDGE_RISK"},"children":[]}]}]}]}]},"tenor":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Trade tenor."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": overnight (today)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tomorrow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot next (spot+1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of days after the current business date (for example, 1D, 2D, 10D)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of weeks after the current business date (for example, 1W, 2W, 3W)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of months after the current business date (for example, 1M, 2M, 3M)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of years after the current business date (for example, 1Y, 2Y, 3Y)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The next International Monetary Market (IMM) settlement date. IMM dates are the third Wednesday of the last month of every quarter (March, June, September, December). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in the next IMM date on or after the spot date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in two IMM dates after the spot date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (spot + IMM) for swaps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (tomorrow + IMM) for swaps"},"children":[]}]}]}]}]},"farTenor":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Far-leg tenor for swaps."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": overnight (today)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tomorrow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot next (spot+1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of days after the current business date (for example, 1D, 2D, 10D)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of weeks after the current business date (for example, 1W, 2W, 3W)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of months after the current business date (for example, 1M, 2M, 3M)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of years after the current business date (for example, 1Y, 2Y, 3Y)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The next International Monetary Market (IMM) settlement date. IMM dates are the third Wednesday of the last month of every quarter (March, June, September, December). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in the next IMM date on or after the spot date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in two IMM dates after the spot date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (spot + IMM) for swaps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (tomorrow + IMM) for swaps"},"children":[]}]}]}]}]},"farFixingTenor":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Far-leg fixing tenor for NDF swaps. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farFixingDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": overnight (today)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tomorrow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": spot next (spot+1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of days after the current business date (for example, 1D, 2D, 10D)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of weeks after the current business date (for example, 1W, 2W, 3W)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of months after the current business date (for example, 1M, 2M, 3M)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a number of years after the current business date (for example, 1Y, 2Y, 3Y)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The next International Monetary Market (IMM) settlement date. IMM dates are the third Wednesday of the last month of every quarter (March, June, September, December). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in the next IMM date on or after the spot date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in two IMM dates after the spot date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (spot + IMM) for swaps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (tomorrow + IMM) for swaps"},"children":[]}]}]}]}]},"farFixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Far-leg fixing date for NDF swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farFixingTenor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]},"farValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Far-leg value date for swaps in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"farSide":{"type":"string","maxLength":10,"description":"May be omitted. Side of the far leg for swaps."},"customerLEI":{"type":"string","maxLength":100,"description":"May be omitted. Customer LEI code."},"counterpartyLEI":{"type":"string","maxLength":100,"description":"May be omitted. Counterparty LEI code."},"upi":{"type":"string","maxLength":50,"description":"May be omitted. Unique Product Identifier for SEF trades."},"uti":{"type":"string","maxLength":150,"description":"May be omitted. Unique Transaction Identifier for SEF trades."},"usi":{"type":"string","maxLength":150,"description":"May be omitted. Unique Swap Identifier for near leg of SEF swaps."},"farUSI":{"type":"string","maxLength":150,"description":"May be omitted. Unique Swap Identifier for far leg of SEF swaps."},"exchange":{"type":"string","maxLength":30,"description":"May be omitted. Exchange ID."},"portfolioId":{"type":"string","maxLength":100,"description":"May be omitted. For batch trades and SSPs, the containing portfolio ID."},"parentUSI":{"type":"string","maxLength":150,"description":"May be omitted. Unique Swap Identifier for SEF swaps."},"isNet":{"type":"boolean","description":"Whether or not the trade was done to net another trade."},"midMarket":{"type":"boolean","description":"Whether or not the trade was done at the mid-market rate."},"regulatory":{"type":"object","description":"May be omitted. An object containing regulatory information.","properties":{"orderSubmissionTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date/time order was submitted in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tradeExecutionTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date/time trade was executed in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"mtf":{"type":"boolean","description":"Whether or not the trade was done in a multilateral trading facility (MTF)."},"mtfVenue":{"type":"string","maxLength":30,"description":"ID of the multilateral trading facility (MTF) venue."},"investmentDecisionMaker":{"type":"string","maxLength":30,"description":"Investment decision maker per MiFID II."},"takerCapacity":{"type":"string","maxLength":10,"description":"Capacity in which the trade is reported, for example dealing on your own account, in matched principal, or any other capacity."},"executingUser":{"type":"string","maxLength":30,"description":"ID of the user who executed the trade."},"executingOrg":{"type":"string","maxLength":30,"description":"ID of the executing organization."},"makerExecutingFirm":{"type":"string","maxLength":30,"description":"ID of the maker executing firm."},"takerExecutingFirm":{"type":"string","maxLength":30,"description":"ID of the taker executing firm."},"siExecution":{"type":"boolean","description":"Whether or not this trade was done by a Systematic Internaliser (SI) per MiFID II."},"siVenue":{"type":"string","maxLength":30,"description":"ID of the Systematic Internaliser (SI) venue."},"sft":{"type":"boolean","description":"Whether or not the trade is a securities financing transaction (SFT) per MiFID II."},"npft":{"type":"boolean","description":"Whether or not the trade is a non-price-forming transaction (NPFT) per MiFID II."},"preTradeWaiver":{"type":"string","maxLength":10,"description":"Pre-trade waiver, if any, per MiFID II."},"postTradeDeferral":{"type":"string","maxLength":10,"description":"Post-trade deferral due to size or liquidity, if any, per MiFID II."},"takerCountryCode":{"type":"string","maxLength":3,"description":"Taker's country code."},"makerCountryCode":{"type":"string","maxLength":3,"description":"Maker's country code."},"customerCountryCode":{"type":"string","maxLength":3,"description":"Customer's country code."},"customerAccount":{"type":"string","maxLength":30,"description":"ID of customer's account."}}},"benchmarkRate":{"type":"number","format":"double","description":"Reference benchmark rate."},"farLegISIN":{"type":"string","maxLength":12,"description":"May be omitted. Far-leg International Securities Identification Number for multi-leg trades."},"nearLegISIN":{"type":"string","maxLength":12,"description":"May be omitted. Near-leg International Securities Identification Number for multi-leg trades."},"isinLinkId":{"type":"string","maxLength":12,"description":"May be omitted. International Securities Identification Number link ID."},"notes":{"type":"string","maxLength":255,"description":"May be omitted. Any notes on the order entered by the order submitting user."},"executionTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time trade was done in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dealtAmount":{"type":"number","format":"double","description":"Amount of the dealt currency."},"settledAmount":{"type":"number","format":"double","description":"Amount of the settlement currency."},"baseAmount":{"type":"number","format":"double","description":"Amount of base currency."},"termAmount":{"type":"number","format":"double","description":"Amount of term currency."},"spotRate":{"type":"number","format":"double","description":"Spot rate of the trade or near leg of the trade."},"rate":{"type":"number","format":"double","description":"All-in rate."},"forwardPoints":{"type":"number","format":"double","description":"May be omitted. Forward points for outright trades and near leg of swaps."},"swapPoints":{"type":"number","format":"double","description":"May be omitted. Swap points, if any."},"farRate":{"type":"number","format":"double","description":"May be omitted. Far-leg rate for swaps."},"farDealtAmount":{"type":"number","format":"double","description":"May be omitted. Far-leg amount in the dealt instrument for swaps."},"farSettledAmount":{"type":"number","format":"double","description":"May be omitted. Far-leg amount in the settlement instrument for swaps."},"farBaseAmount":{"type":"number","format":"double","description":"May be omitted. Far-leg amount in the base instrument for swap."},"farTermAmount":{"type":"number","format":"double","description":"May be omitted. Far-leg amount in the term instrument for swaps."},"farForwardPoints":{"type":"number","format":"double","description":"May be omitted. Far-leg forward points for swaps."},"mifidBenchmarkRate":{"type":"number","format":"double","description":"May be omitted. Reference benchmark rate per MiFID II."},"fees":{"type":"number","format":"double","description":"May be omitted. Fees on the trade, if any."},"initialSettledAmount":{"type":"number","format":"double","description":"May be omitted. Initial settled amount before any amendment."},"stream":{"type":"string","maxLength":30,"description":"May be omitted. ID of the stream that priced the trade."},"midRate":{"type":"number","format":"double","description":"May be omitted. Spot or near-leg mid rate for swaps."},"farMidRate":{"type":"number","format":"double","description":"May be omitted. Far-leg mid rate for swaps."},"coverRate":{"type":"number","format":"double","description":"May be omitted. Rate of the trade that covered this trade."},"coverSpotRate":{"type":"number","format":"double","description":"May be omitted. Spot rate of the trade that covered this trade."},"coverForwardPoints":{"type":"number","format":"double","description":"May be omitted. Forward points of the trade that covered this trade."},"coverFarRate":{"type":"number","format":"double","description":"May be omitted. Far-leg rate of the trade that covered this trade."},"coverFarSpotRate":{"type":"number","format":"double","description":"May be omitted. Far-leg spot rate of the trade that covered this trade."},"coverFarForwardPoints":{"type":"number","format":"double","description":"May be omitted. Far-leg forward points of the trade that covered this trade."},"coverRiskManagementType":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cover risk management type. Applicable when received by a maker."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_COVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"children":[]}]}]}]}]},"spreads":{"type":"object","description":"May be omitted. Spreads on the trade. Available to makers who have configured STP to include market rate and spreads.","properties":{"pmNearSpread":{"type":"number","format":"double","description":"Trading spread. Total forward spread applied to the near leg. This value includes price improvement, if any."},"pmFarSpread":{"type":"number","format":"double","description":"Trading spread. Total forward spread applied to the far leg. This value includes price improvement, if any."},"pmPreSpotSpread":{"type":"number","format":"double","description":"Trading spread. Spot spread applied by trading via price making configurations in the pricing engine. This is applicable to spot, outright, and swap trades."},"pmSpotSpread":{"type":"number","format":"double","description":"Trading spread. Spot spread applied by trading via price making configurations in the pricing engine. This is applicable to spot, outright, and swap trades."},"ppSpotSpread":{"type":"number","format":"double","description":"Sales spread. Spot spread applied by a salesperson via the price provisioning section in the pricing engine. This is applicable to spot, outright, and swap trades."},"ppNearSpread":{"type":"number","format":"double","description":"Sales spread. Fixed spread applied to the near leg as defined in the price provisioning rule applied to the spot rate."},"ppFarSpread":{"type":"number","format":"double","description":"Sales spread. Fixed spread applied to the near leg as defined in the price provisioning rule applied to the spot rate."},"ppCustSpread":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales spread. Sum of the spot spread ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ppSpotSpread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the near leg spread ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ppNearSpread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and the far leg forward spread ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ppFarSpread"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"bookName":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be omitted. Only applicable to FX Yield Manager. If FX Yield Manager is used to manage positions, this is the name of the book, if any, to which the trade is entered."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Cover trades, both customer trades and its cover trades."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Warehoused customer trades, FX Yield Manager hedging trades."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"empty = No-cover trades, unmanaged trades, desk trades."},"children":[]}]}]}]}]},"coveredTradeId":{"type":"string","maxLength":255,"description":"May be omitted. ID of the trade covered by this trade, if any."},"coveredCounterparty":{"type":"string","maxLength":30,"description":"ID of the customer org that originated the trade with the broker."},"isSynthetic":{"type":"boolean","description":"May be omitted. Whether or not the symbol is a synthetic currency pair."},"syntheticComponent":{"type":"string","maxLength":10,"description":"May be omitted. Component currency used to price the synthetic currency pair."},"MT300Field72":{"type":"string","maxLength":210,"description":"SWIFT MT 300 Foreign Exchange Confirmation, field 72 Sender to Receiver Information"},"customParameters":{"type":"object","maxLength":3500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of parameters that are unique to your organization. The number of parameters, their keynames, and values are defined by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Integral Technical Account Manager to enable and configure custom parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your custom parameters are included in API responses and in STP trade download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom parameters sent to Integral via API are stored in the database directly. No validation is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customParameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters, including all keys, values, and JSON syntax characters."},"children":[]}]}]}],"properties":{"keyName":{"type":"string","description":"The keyname of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."},"value":{"type":"string","description":"The value of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."}}}}}},"components/schemas/rfsRequest":{"id":"components/schemas/rfsRequest","kind":"json-schema","title":"rfsRequest","data":{"type":"object","properties":{"clOrderId":{"type":"string","maxLength":60,"description":"Request reference ID assigned by you."},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"amount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spot, outright, NDF: dealt amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swap: near leg dealt amount."},"children":[]}]}]}]}]},"dealtCurrency":{"type":"string","maxLength":17,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt currency. Must one of the instruments in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"symbol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expiry":{"type":"integer","format":"int64","minimum":30,"maximum":86400,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The definition of this property depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rfq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest/t=request&path=rfq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfq"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rfq=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not included (RFS workflow) Request expiry time in seconds when the request is received."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration also depends on the server expiry configuration. Typical expiration time is 120 seconds."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of this parameter is greater than configured on the server, the server value is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rfq=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RFQ workflow) Duration time in seconds for a single quote. Minimum 30 seconds. Maximum 86400 seconds (24 hours). This value must match exactly the value configured on the server."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server must be configured to enable the RFQ workflow. Please contact your Technical Account Manager to discuss settings."},"children":[]}]}]}]}]},"rfq":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote workflow of the request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not included or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=RFS workflow: request a stream of quotes. The ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest/t=request&path=expiry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") property specifies the expiry time of the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=RFQ workflow: request a single quote that is valid for a duration specified by the ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest/t=request&path=expiry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") property. The server must be configured to enable the RFQ workflow. Please contact your Technical Account Manager to discuss settings."},"children":[]}]}]}]}]},"nearValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenor or broken date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spot, outright: value date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swap: near leg value date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF: value date if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixingDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]}]},"farDealtAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps, fwd/fwds, NDF swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Far leg dealt amount."},"children":[]}]}]}]},"farValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for swaps, fwd/fwds, NDF swaps."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Tenor or broken date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swap, fwd/fwd: far leg value date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF swap: value date required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farFixingDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]}]},"fixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF fixing date, tenor or broken date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nearValueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]},"farFixingDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF swap far leg fixing date, tenor or broken date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farValueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TWO_WAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the requester’s perspective and always for the dealt currency."},"children":[]}]}]}]},"priceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FwdFwd"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDFSwap"},"children":[]}]}]}]}]},"customerAccount":{"type":"string","maxLength":30,"description":"ID of the legal entity for which quote request is being executed."},"customerOrg":{"type":"string","maxLength":30,"description":"ID of the organization for which quote request is being executed."},"priceViewType":{"type":"integer","minimum":0,"maximum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether quotes from all liquidity providers are collected into a single response (recommended) or each provider quote is sent as separate response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1=quotes collected into a single response (recommended)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 or any positive integer=non aggregated view, each liquidity-provider quote is sent as a separate response."},"children":[]}]}]}]}]},"depth":{"type":"integer","minimum":1,"description":"Requested depth-of-book starting with the top of the book. For example, if set to 5, you receive a maximum of 5 quotes on each side (buy/sell) is 5 as long as providers respond with 5 or more quotes."},"providers":{"type":"array","items":{"type":"string","maxLength":30},"description":"List of provider IDs to receive the request. If not specified, the server sends the request to all eligible providers."},"customParameters":{"type":"object","maxLength":3500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of parameters that are unique to your organization. The number of parameters, their keynames, and values are defined by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Integral Technical Account Manager to enable and configure custom parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your custom parameters are included in API responses and in STP trade download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom parameters sent to Integral via API are stored in the database directly. No validation is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customParameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters, including all keys, values, and JSON syntax characters."},"children":[]}]}]}],"properties":{"keyName":{"type":"string","description":"The keyname of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."},"value":{"type":"string","description":"The value of a custom parameter key/value pair as defined by your organization. Contact your Integral Technical Account Manager to enable and configure custom parameters."}}}},"required":["clOrderId","symbol","amount","dealtCurrency","expiry","nearValueDate","side","priceType","customerAccount","customerOrg"]}},"components/schemas/rfsResponseSuccess":{"id":"components/schemas/rfsResponseSuccess","kind":"json-schema","title":"rfsResponseSuccess","data":{"type":"object","properties":{"requestId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID assigned to your request by the server. Use this ID to accept a quote. You need to use this ID or your ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status."},"children":[]}]}]}]},"clOrderId":{"type":"string","maxLength":60,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID assigned by you from your request. You need to use this ID or the server ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status."},"children":[]}]}]}]},"event":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Indicates the request is received for processing. You need to query your request for get quotes and status of your request."},"children":[]}]}]}]}}}},"components/schemas/rfsResponse":{"id":"components/schemas/rfsResponse","kind":"json-schema","title":"rfsResponse","data":{"type":"object","discriminator":{"propertyName":"event"},"properties":{"clOrderId":{"type":"string","maxLength":60,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID assigned by you from your request. You need to use this ID or the server ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status."},"children":[]}]}]}]},"requestId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Use this ID to accept a quote. You need to use this ID or your ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"transactionId":{"type":"string","maxLength":255,"description":"Request transaction ID assigned by Integral."},"ttl":{"type":"number","format":"int32","description":"Originating RFS request expiry time."},"expiryTimeInSeconds":{"type":"number","format":"int32","description":"Originating RFS request expiry time."},"event":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request for quote is received for processing, quoting has not started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request to trade a quote is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_WITHDRAWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request was canceled by you."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request expired and inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_VERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": executed trade in response to your request to trade a quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request to trade a quote pending."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": request to trade a quote rejected by one or more liquidity providers."},"children":[]}]}]}]}]}}}},"components/schemas/rfsResponseQuoted":{"id":"components/schemas/rfsResponseQuoted","kind":"json-schema","title":"rfsResponseQuoted","data":{"type":"object","properties":{"clOrderId":{"type":"string","maxLength":60,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID assigned by you from your request. You need to use this ID or the server ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status."},"children":[]}]}]}]},"requestId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Use this ID to accept a quote. You need to use this ID or your ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"transactionId":{"type":"string","maxLength":255,"description":"Request transaction ID assigned by Integral. Must be included on quote acceptance in the RFQ workflow."},"ttl":{"type":"number","format":"int32","description":"Originating RFS request expiry time."},"event":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a quote in response to your request for quote."},"children":[]}]}]}]},"quotes":{"type":"array","items":{"$ref":"#/components/schemas/quote"},"description":"Collection of quotes."}}}},"components/schemas/rfsResponseExecuted":{"id":"components/schemas/rfsResponseExecuted","kind":"json-schema","title":"rfsResponseExecuted","data":{"type":"object","properties":{"clOrderId":{"type":"string","maxLength":60,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID assigned by you from your request. You need to use this ID or the server ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status."},"children":[]}]}]}]},"requestId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Use this ID to accept a quote. You need to use this ID or your ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to query your request to get quotes and status. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"transactionId":{"type":"string","maxLength":255,"description":"Request transaction ID assigned by Integral."},"ttl":{"type":"number","format":"int32","description":"Originating RFS request expiry time."},"event":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_VERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": executed trade in response to your request to trade a quote."},"children":[]}]}]}]},"trades":{"type":"array","description":"Collection of trades.","items":{"$ref":"#/components/schemas/trade"}}}}},"components/schemas/rate":{"id":"components/schemas/rate","kind":"json-schema","title":"rate","data":{"type":"object","properties":{"legType":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates near or far leg:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=Near"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=Far"},"children":[]}]}]}]}]},"quoteId":{"type":"string","maxLength":255,"description":"ID of the price in the quote. Use this ID for previously quoted orders."},"type":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID"},"children":[]}]}]}]}]},"dealtAmount":{"type":"number","format":"double","description":"Dealt amount."},"settledAmount":{"type":"number","format":"double","description":"Settled amount."},"provider":{"type":"string","maxLength":30,"description":"ID of provider supplying the price."},"rate":{"type":"number","format":"double","description":"All-in rate."},"spotRate":{"type":"number","format":"double","description":"Spot rate."},"forwardPoint":{"type":"number","format":"double","description":"Forward points."},"midRate":{"type":"number","format":"double","description":"Mid rate."}}}},"components/schemas/quote":{"id":"components/schemas/quote","kind":"json-schema","title":"quote","data":{"type":"object","properties":{"requestId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID assigned by Integral. Returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/quoteRequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"priceType":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outright"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDF"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swap"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FwdFwd"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NDFSwap"},"children":[]}]}]}]}]},"effectiveTime":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time in seconds when the quote is active. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (zero) means that you can accept the quote immediately."},"children":[]}]}]}]},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"ttl":{"type":"integer","format":"int32","description":"Quote valid time (time to live) in seconds."},"dealtCurrency":{"type":"string","maxLength":17,"description":"Dealt currency."},"status":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the quote:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Inactive"},"children":[]}]}]}]}]},"nearValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spot, Outright: value date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swap: near leg value date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDF: value date if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"farFixingDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not specified."},"children":[]}]}]}]}]},"farValueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Far-leg value date in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for swaps (spot/forward, forward/forward, NDF)."},"children":[]}]}]}]},"bids":{"type":"array","description":"A collection of bid rates.","items":{"$ref":"#/components/schemas/rate"}},"offers":{"type":"array","description":"A collection of offer rates.","items":{"$ref":"#/components/schemas/rate"}}}}},"components/schemas/acceptQuote":{"id":"components/schemas/acceptQuote","kind":"json-schema","title":"acceptQuote","data":{"type":"object","properties":{"quoteId":{"type":"string","maxLength":255,"description":"Quote ID from one of the quotes received in response to a Query Request."},"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the requester's perspective and always for the dealt currency. For multi-leg requests this is the side of far leg."},"children":[]}]}]}],"example":"BUY"},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"dealtCurrency":{"type":"string","maxLength":17,"description":"Dealt currency."},"transactionId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request transaction ID assigned by Integral from the quote you are accepting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for quote acceptance in the RFQ workflow ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest/t=request&path=rfq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfq"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your request "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"clOrderId":{"type":"string","maxLength":60,"description":"Originating RFS ID assigned by you."},"rfq":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote workflow of your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for quote acceptance in the RFQ workflow ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest/t=request&path=rfq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rfq"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your request "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#rfsrfq/quoterequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not included=RFS workflow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=RFQ workflow."},"children":[]}]}]}]}]}},"required":["quoteId","side","symbol","dealtCurrency","clOrderId"]}},"components/schemas/balanceResponse":{"id":"components/schemas/balanceResponse","kind":"json-schema","title":"balanceResponse","data":{"type":"object","properties":{"custodyOrg":{"type":"string","maxLength":255,"description":"Custody organization ID associated with the balances.","example":"CustodyOrgName"},"customerOrg":{"type":"string","maxLength":255,"description":"Customer organization ID associated with the balances.","example":"CustomerOrgName"},"balances":{"type":"array","items":{"$ref":"#/components/schemas/balance"}}}}},"components/schemas/brokerBalanceResponse":{"id":"components/schemas/brokerBalanceResponse","kind":"json-schema","title":"brokerBalanceResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/balanceResponse"}}},"components/schemas/brokerBalanceUpdateRequest":{"id":"components/schemas/brokerBalanceUpdateRequest","kind":"json-schema","title":"brokerBalanceUpdateRequest","data":{"type":"object","properties":{"custodyOrg":{"type":"string","maxLength":255,"description":"Custody organization ID associated with the balances.","example":"custodyOrgName"},"customerOrg":{"type":"string","maxLength":255,"description":"Customer organization ID associated with the balances.","example":"customerOrgName"},"externalUpdateId":{"type":"string","maxLength":255,"description":"External update ID associated with the balances.","example":"e-NAF-9e006def0021"},"amount":{"type":"number","format":"double","description":"Amount associated with the balances.","example":10.12922},"currency":{"type":"string","maxLength":17,"description":"Currency associated with the balances.","example":"BTC"},"notes":{"type":"string","maxLength":255,"description":"Notes associated with the balances. Visible to Admin users in your organization.","example":"Notes on the balance update."},"timestamp":{"type":"string","format":"date-time","description":"Timestamp associated with the balances.","example":"2025-01-01T00:00:00Z"}}}},"components/schemas/brokerBalanceUpdateResponse":{"id":"components/schemas/brokerBalanceUpdateResponse","kind":"json-schema","title":"brokerBalanceUpdateResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Withdrawal transaction ID.","example":"769800519366885376"},"status":{"type":"string","maxLength":255,"description":"Success or failure of the update. \n","example":"Success"},"errorReason":{"type":"string","maxLength":255,"description":"Error message returned if the update fails.","example":"Error message"}}}},"components/schemas/balance":{"id":"components/schemas/balance","kind":"json-schema","title":"balance","data":{"type":"object","properties":{"currency":{"type":"string","maxLength":17,"description":"Asset symbol.","example":"BTC"},"balance":{"type":"number","format":"double","description":"Available balance.","example":10.12922},"holds":{"type":"number","format":"double","description":"Active holds, if any.","example":1.0092},"available":{"type":"number","format":"double","description":"Total amount available.","example":9.12002},"tradingBalance":{"type":"number","format":"double","description":"Total amount available for trading.","example":9.12002}}}},"components/schemas/assetDetail":{"id":"components/schemas/assetDetail","kind":"json-schema","title":"assetDetail","data":{"type":"object","properties":{"currency":{"type":"string","maxLength":17,"description":"Digital asset code.","example":"BAT"},"minWithdrawAmount":{"type":"string","maxLength":32,"description":"Minimum withdrawal amount of digital asset.","example":70},"depositStatus":{"type":"boolean","description":"Whether the digital asset can be deposited.","example":true},"withdrawFee":{"type":"number","format":"int64","description":"Fee for withdrawing the digital asset.","example":35},"withdrawStatus":{"type":"boolean","description":"Whether the digital asset can be withdrawn.","example":false}}}},"components/schemas/depositAddressResponse":{"id":"components/schemas/depositAddressResponse","kind":"json-schema","title":"depositAddressResponse","data":{"type":"object","properties":{"address":{"type":"string","maxLength":255,"description":"Deposit address.","example":"bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu"},"currency":{"type":"string","maxLength":17,"description":"Digital asset code.","example":"BTC"},"tag":{"type":"string","maxLength":255,"description":"Additional field required by some blockchains for identifying the transaction recipient beyond a wallet address.","example":""},"url":{"type":"string","maxLength":2048,"example":"https://blockchair.com/bitcoin/address/bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu"}}}},"components/schemas/deposit":{"id":"components/schemas/deposit","kind":"json-schema","title":"deposit","data":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Deposit transaction ID.","example":"769800519366885376"},"amount":{"type":"string","maxLength":32,"description":"Deposit amount.","example":"0.01"},"currency":{"type":"string","maxLength":17,"description":"Digital asset code.","example":"BTC"},"network":{"type":"string","maxLength":255,"description":"Chain name / network.","example":"BTC"},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer that indicates the status of the deposit transactions to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = successful"},"children":[]}]}]}]}],"example":0},"address":{"type":"string","maxLength":255,"description":"Deposit address.","example":"bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu"},"tag":{"type":"string","maxLength":255,"description":"Additional field required by some blockchains for identifying the transaction recipient beyond a wallet address.","example":""},"txId":{"type":"string","maxLength":255,"description":"Transaction ID.","example":"98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC"},"createdTime":{"type":"integer","format":"int64","description":"The time the transaction was created. Unix time in milliseconds.","example":1661493146000},"confirmedTime":{"type":"integer","format":"int64","description":"The time the transaction was confirmed. Unix time in milliseconds.","example":1661493146000}}}},"components/schemas/withdraw":{"id":"components/schemas/withdraw","kind":"json-schema","title":"withdraw","data":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Withdrawal transaction ID.","example":"769800519366885376"},"amount":{"type":"string","maxLength":32,"description":"Withdrawal amount.","example":"0.01"},"transactionFee":{"type":"string","maxLength":32,"description":"The fee for the transaction, if any.","example":"0.0001"},"currency":{"type":"string","maxLength":17,"description":"Digital asset code.","example":"BTC"},"network":{"type":"string","maxLength":255,"description":"Chain name / network","example":"BTC"},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer that indicates the status of the withdrawal transactions to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = email sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = awaiting approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 = failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 = completed"},"children":[]}]}]}]}],"example":0},"address":{"type":"string","maxLength":255,"description":"Withdrawal address.","example":"bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu"},"tag":{"type":"string","maxLength":255,"description":"Additional field required by some blockchains for identifying the transaction recipient beyond a wallet address.","example":""},"txId":{"type":"string","maxLength":255,"description":"Transaction ID.","example":"98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC"},"createdTime":{"type":"integer","format":"int64","description":"The time the transaction was created. Unix time in milliseconds.","example":1661493146000},"updatedTime":{"type":"integer","format":"int64","description":"The time the transaction was updated. Unix time in milliseconds.","example":1661493146000},"reason":{"type":"string","maxLength":255,"example":"Rejection reason"}}}},"components/schemas/withdrawResponse":{"id":"components/schemas/withdrawResponse","kind":"json-schema","title":"withdrawResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Withdrawal transaction ID.","example":"769800519366885376"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer that indicates the status of the withdrawal transactions to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 = email sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = awaiting approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 = failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 = completed"},"children":[]}]}]}]}],"example":0},"errorReason":{"type":"string","maxLength":255,"description":"Error message returned if the withdrawal fails.","example":"Error message"}}}},"components/schemas/position":{"id":"components/schemas/position","kind":"json-schema","title":"position","data":{"type":"object","properties":{"side":{"type":"string","maxLength":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Long"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Short"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"valueDate":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value date of the trades that make up the position in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY=MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"level":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No default value. The level at which the position is calculated:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": legal entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": organization"},"children":[]}]}]}]}]},"levelValue":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of either the user or organization based on the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"netOpenBase":{"type":"number","format":"double","description":"Net open amount in base currency."},"netOpenterm":{"type":"number","format":"double","description":"Net open amount in term currency. Note the property name is not a typo (\"term\" is lowercase)."},"rate":{"type":"number","format":"double","description":"The weighted average buy or sell rate of the current position."},"realizedPnL":{"type":"number","format":"double","description":"The profit or loss in the base currency determined by taking all trades (or portions thereof) that are closed and computing the profit for each pair of opposing buy/sell trades."},"unrealizedPnL":{"type":"number","format":"double","description":"The profit or loss in the base currency determined by taking the position's currency pair rate against the current market rate at the position amount. Essentially, the unrealized P/L is the profit or loss if the position was closed at the current close rate."},"pnlCurrency":{"type":"string","maxLength":17,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The P&L reporting currency."},"children":[]}]}]}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/position"},"description":"List of child positions, if any."}}}},"components/schemas/instrument":{"id":"components/schemas/instrument","kind":"json-schema","title":"Instrument","data":{"type":"object","title":"Instrument","properties":{"shortName":{"type":"string","maxLength":30,"description":"ID of the instrument."},"instrumentType":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CURRENCY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"METAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDEX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENERGY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRYPTO"},"children":[]}]}]}]}]},"roundingType":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_CEILING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_DOWN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_FLOOR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_HALF_DOWN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_HALF_EVEN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_HALF_UP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_UNNECESSARY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ROUND_UP"},"children":[]}]}]}]}]},"tickValue":{"type":"number","description":"Tick increment."}}}},"components/schemas/instrumentList":{"id":"components/schemas/instrumentList","kind":"json-schema","title":"All instruments","data":{"type":"array","title":"All instruments","items":{"$ref":"#/components/schemas/instrument"}}},"components/schemas/symbol":{"id":"components/schemas/symbol","kind":"json-schema","title":"Symbol","data":{"type":"object","title":"Symbol","properties":{"instrument":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dealt instrument pair (currency, metal, energy, index, crypto), seven-character ISO code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUD/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"spotPrecision":{"type":"number","description":"Decimals to which the symbol is quoted for spot prices."},"spotPointsPrecision":{"type":"number","description":"Decimals to which the symbol is quoted for spot points."},"forwardPointsPrecision":{"type":"number","description":"Decimals to which the symbol is quoted for forward points."},"forwardRatePrecision":{"type":"number","description":"Decimals to which the symbol is quoted for forward rates."},"pipsFactor":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used for 1/x to determine the size of a pip. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10000.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in 1/10,000th or decimalized to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"instrumentType":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CURRENCY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"METAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDEX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENERGY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRYPTO"},"children":[]}]}]}]}]},"nonDeliverable":{"type":"boolean","description":"Whether or not the symbol includes nondeliverable a instrument."},"spotValueDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current spot date of the symbol in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/symbolList":{"id":"components/schemas/symbolList","kind":"json-schema","title":"All symbols","data":{"type":"array","title":"All symbols","items":{"$ref":"#/components/schemas/symbol"}}},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"type":"string","maxLength":30,"description":"API user ID."},"pass":{"type":"string","maxLength":128,"description":"Password."},"org":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API user’s organization ID."},"children":[]}]}]}]}},"required":["user","pass","org"]},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"properties":{"status":{"type":"string","maxLength":36,"description":"Request status."},"errorCode":{"type":"string","maxLength":64,"description":"Error code, if any.","nullable":true},"responseTuples":{"type":"object","description":"List of JSON objects with additional information on the response, if any.","nullable":true},"expiryTime":{"type":"integer","format":"int64","description":"Expiry time of API session in milliseconds."},"serverUTCTime":{"type":"integer","format":"int64","description":"Start time of API session in milliseconds."}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"Set-Cookie":{"type":"string","maxLength":255,"description":"May be several in header. One contains token.","example":"SSO_TOKEN=hidH61Uy63IYT08avDFEUUrEO_Sn-BZ6yEqyON5SJS_h0gU8vOaNItVGllwHTH7yFZgFtFN9jYlSRTHEBIBKNQ; Domain=.integral.com; Path=/"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"properties":{"status":{"type":"string","maxLength":36,"description":"Request status."},"errorCode":{"type":"string","maxLength":64,"description":"Error code, if any.","nullable":true},"responseTuples":{"type":"object","description":"List of JSON objects with additional information on the response, if any.","nullable":true},"valid":{"type":"boolean","description":"Whether or not the token is valid."},"expiryTime":{"type":"integer","format":"int64","description":"Expiry time of API session in milliseconds."},"apiVersion":{"type":"string","maxLength":32,"description":"The API version that you are interacting with."},"expired":{"type":"boolean","description":"Whether or not the token is expired."}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"string","maxLength":35,"example":"EUR/USD"},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"string","maxLength":32,"default":"TOB"},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/spotRate-TOB"},{"$ref":"#/components/schemas/spotRate-FULL"},{"$ref":"#/components/schemas/spotRate-RAW"}]},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"TOB"},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"string","maxLength":30,"example":"BrokerOrgA1"},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"string","maxLength":30},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"string","maxLength":30,"example":"BNK1-4HOrg"},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"EUR/USD,USD/JPY"},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"string","maxLength":20,"example":"2024-10-24","default":"Current business date"},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"string","maxLength":20,"default":"SPOT"},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"string","maxLength":53,"example":"1500-1700","default":"Currently active market data sets"},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"string","maxLength":35,"example":"AUD/USD"},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"rate":{"type":"number","format":"double","description":"Benchmark rate."},"uid":{"type":"string","maxLength":128,"description":"GUID for the rate."},"timestamp":{"type":"integer","format":"int64","description":"Rate timestamp in milliseconds Unix time, UTC timezone."}},"example":{"symbol":"AUD/USD","rate":0.69746,"uid":"G-4796976cd-17528d7b6ea-FXB-6237f19","timestamp":1602708027114}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"symbol":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base and term currency separated by a slash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR/USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate, either bid or offer based on value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}]},"isBid":{"type":"string","maxLength":6,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not the rate is bid or offer:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=bid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=offer"},"children":[]}]}]}]}]}]},"timestamp":{"type":"integer","format":"int64","description":"Rate timestamp in Unix time, UTC timezone."},"bid":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not the rate is bid or offer:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=bid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=offer"},"children":[]}]}]}]}]}]}},"example":{"symbol":"AUD/USD","rate":0.69746,"isBid":true,"timestamp":1602505075906,"bid":true}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"Order25"},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/order"}},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"4820276016"},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"4820275011"},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"tradeId":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the booked trade in Integral’s system."},"children":[]}]}]}]},"createdTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time (GMT) the trade was booked in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"clientRequestId":{"type":"string","maxLength":255,"description":"ID book trade request assigned by you. Returned so that you can associate the request and booked trade."}},"example":{"tradeId":"FXI30501001","createdTime":"2022-01-19 12:36:27,200 +0000","clientRequestId":"req swap 1"}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"OrderXEL278vv1"},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"4820275011"},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/trade"}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"originalTradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the original trade that was amended."},"tradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the new trade."},"createdTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time (GMT) the trade was booked in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"originalTradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the original trade that was rolled."},"tradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the new trade."},"createdTime":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time (GMT) the trade was booked in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"originalTradeId":"FXI30500922","tradeId":"FXI30501001","createdTime":"2025-01-10 12:36:27,200 +0000"}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"originalTradeId":{"type":"string","minLength":5,"maxLength":30,"description":"ID of the original trade that was amended."},"trades":{"type":"array","items":{"type":"object","properties":{"referenceId":{"type":"string","description":"Your reference ID for the allocation."},"tradeId":{"type":"string","description":"ID of the allocation."}}}}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/tradeCancelResponseTradeId"},{"$ref":"#/components/schemas/tradeCancelResponseClientRequestId"}]},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"string","maxLength":32,"example":"FXI9222877182"},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The validation error reason code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Reason-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of codes."},"children":[]}]}]}]}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"view1MultiLP5"},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/rfsResponseQuoted"},{"$ref":"#/components/schemas/rfsResponseExecuted"},{"$ref":"#/components/schemas/rfsResponse"}],"discriminator":{"propertyName":"event","mapping":{"QUOTE":"#/components/schemas/rfsResponseQuoted","REQUEST_RECEIVED":"#/components/schemas/rfsResponse","REQUEST_EXPIRED":"#/components/schemas/rfsResponse","REQUEST_WITHDRAWN":"#/components/schemas/rfsResponse","REQUEST_DECLINED":"#/components/schemas/rfsResponse","REQUEST_ACCEPTED":"#/components/schemas/rfsResponse","TRADE_VERIFIED":"#/components/schemas/rfsResponseExecuted","TRADE_PENDING":"#/components/schemas/rfsResponseExecuted","TRADE_REJECTED":"#/components/schemas/rfsResponse"}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"string","maxLength":255,"example":"G4796976d517b1786e1fa242"},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/rfsResponseQuoted"},{"$ref":"#/components/schemas/rfsResponseExecuted"},{"$ref":"#/components/schemas/rfsResponse"}],"discriminator":{"propertyName":"event","mapping":{"QUOTE":"#/components/schemas/rfsResponseQuoted","REQUEST_RECEIVED":"#/components/schemas/rfsResponse","REQUEST_EXPIRED":"#/components/schemas/rfsResponse","REQUEST_WITHDRAWN":"#/components/schemas/rfsResponse","REQUEST_DECLINED":"#/components/schemas/rfsResponse","REQUEST_ACCEPTED":"#/components/schemas/rfsResponse","TRADE_VERIFIED":"#/components/schemas/rfsResponseExecuted","TRADE_PENDING":"#/components/schemas/rfsResponse","TRADE_REJECTED":"#/components/schemas/rfsResponse"}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"string","maxLength":32},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"string","maxLength":30,"example":"pfOrg"},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/position"}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"type":"string","maxLength":20,"example":"2022-03-11"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"string","maxLength":17},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"string","maxLength":255},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"X-Rate-Limit":{"type":"integer","format":"int32","description":"Calls per hour allowed by the user"}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"integer","maximum":1000},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/deposit"}},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"number"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object","properties":{"X-Rate-Limit":{"type":"integer","format":"int32","description":"calls per hour allowed by the user"}}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"string","maxLength":256},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/withdraw"}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"integer","default":50,"example":20},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/tradeStp"}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"properties":{"startDate":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beginning "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of trades to reset for STP eligibility, inclusive, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2022-04-21 13:00:00,000 +0000"},"endDate":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of trades to reset for STP eligibility, inclusive, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss,SSS Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2022-04-22 13:00:00,000 +0000"}},"required":["startDate","endDate"]},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"string","maxLength":17,"example":"BTC"},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/assetDetail"}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"string","maxLength":17,"example":"USD"},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"string","maxLength":34,"example":"EURUSD"},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/symbolList"},{"$ref":"#/components/schemas/instrumentList"}]},"id":"schema_391"}},"exampleStore":{"components/examples/mdsRespRealTimeOneRate":{"id":"components/examples/mdsRespRealTimeOneRate","value":[{"id":"RealTimeMDS","date":null,"timeWindow":null,"name":"Real-time market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":null,"currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"}]}],"summary":"Real-time market data set with one rate"},"components/examples/mdsRespRealTimeMultipleRates":{"id":"components/examples/mdsRespRealTimeMultipleRates","value":[{"id":"RealTimeMDS","date":null,"timeWindow":null,"name":"Real-time market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":null,"currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":null,"tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":144.34,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"summary":"Real-time market data set with multiple rates"},"components/examples/mdsRespEodOneRate":{"id":"components/examples/mdsRespEodOneRate","value":[{"id":"EODMDS","date":"2024-11-14","timeWindow":null,"name":"End-of-day market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"}]}],"summary":"End-of-day market data set with one rate"},"components/examples/mdsRespEodMultipleRates":{"id":"components/examples/mdsRespEodMultipleRates","value":[{"id":"EODMDS","date":"2024-11-05","timeWindow":null,"name":"End-of-day market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e313","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":144.34,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"summary":"End-of-day market data set with multiple rates"},"components/examples/mdsRespFixedOneRate":{"id":"components/examples/mdsRespFixedOneRate","value":[{"id":"FixedPeriodMDS","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":null,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"}]}],"summary":"Fixed-period market data set with one rate"},"components/examples/mdsRespFixedMultipleRates":{"id":"components/examples/mdsRespFixedMultipleRates","value":[{"id":"FixedPeriodMDS4H","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e313","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"summary":"Fixed-period market data set with multiple rates"},"components/examples/mdsRespFixedMultipleDataSets":{"id":"components/examples/mdsRespFixedMultipleDataSets","value":[{"id":"FixedPeriodMDS4H","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"R_17fec871243_1e32a","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"OK","rateId":"R_17fec878bef3_10947","tenor":"SPOT","currencyPair":"AUD/CAD","bid":0.9141,"mid":null,"offer":0.9148,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"R_17fec871243_1e2f3","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]},{"id":"FixedPeriodMDS4H_AR2","date":"2024-11-14","timeWindow":"1200-1600","name":"4HProduct MDS second session","createdTime":"2024-11-14 11:50:00,000 +0000","activationTime":"2024-11-14 12:00:00,000 +0000","validUntil":"2024-11-14 16:00:00,000 +0000","nextCreationTime":"2024-11-14 15:50:00,000 +0000","rates":[{"status":"OK","rateId":"Rf_17fec80001_1ce33","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1634,"mid":null,"offer":1.1653,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":"Rf_17fec8040b_1ce62","tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"Rf_17fec803b2_1bb85","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"summary":"Multiple fixed-period market data sets"},"components/examples/orderPlaceExampleLimit":{"id":"components/examples/orderPlaceExampleLimit","value":{"coId":"Order25","type":"Limit","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.0973655,"timeInForce":"GTC"},"summary":"Place limit order (GTC)"},"components/examples/orderPlaceExampleLimitCustomParams":{"id":"components/examples/orderPlaceExampleLimitCustomParams","value":{"coId":"8932452311958","type":"Limit","side":"Sell","symbol":"USD/CAD","currency":"USD","size":10000,"price":1.26963,"timeInForce":"GTT","expiryTime":"3","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"summary":"Place limit order w/ custom params"},"components/examples/orderPlaceExampleLimitIOC":{"id":"components/examples/orderPlaceExampleLimitIOC","value":{"coId":"8932452311944","type":"Limit","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.0971678,"timeInForce":"IOC"},"summary":"Place limit order (IOC)"},"components/examples/orderPlaceExampleAtBest":{"id":"components/examples/orderPlaceExampleAtBest","value":{"coId":"1685730661","type":"AtBest","side":"Buy","symbol":"USD/INR","currency":"USD","size":1000000,"priceType":"NDF","timeInForce":"FOK","org":"CustomerOrg","valueDate":"2023-06-15"},"summary":"Place at best order"},"components/examples/orderPlaceExamplePQ":{"id":"components/examples/orderPlaceExamplePQ","value":{"coId":"pq11233","rateId":"4HProduct|2022-11-14|0800-1200|EURUSD|SPOT","currency":"EUR","size":9000000,"type":"PQ","price":1.1652,"side":"Buy","symbol":"EUR/USD","timeInForce":"FOK"},"summary":"Place previously quoted order"},"components/examples/orderPlaceExampleMarket":{"id":"components/examples/orderPlaceExampleMarket","value":{"coId":"Order20","type":"Market","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":9000000,"price":1.1864,"timeInForce":"IOC"},"summary":"Place market order (IOC)"},"components/examples/orderPlaceExampleStop":{"id":"components/examples/orderPlaceExampleStop","value":{"coId":"Stop11","type":"Stop","timeInForce":"GTC","side":"Sell","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.19353,"stopPrice":1.19353,"execFlags":["BidTrigger"]},"summary":"Place stop order (GTC)"},"components/examples/orderPlaceExampleOnBehalfOf":{"id":"components/examples/orderPlaceExampleOnBehalfOf","value":{"coId":"Order25FI34_231233","type":"Limit","timeInForce":"IOC","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.1867,"org":"FI34","account":"FI34_LE"},"summary":"Place on behalf of order"},"components/examples/orderResponseExampleStop":{"id":"components/examples/orderResponseExampleStop","value":{"coId":"Stop11","type":"Stop","rateId":"M-FP.G479697b2e_99cf1__17fc06ddda2_55ba","timeInForce":"GTC","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.19353,"stopPrice":1.19353,"execFlags":["BidTrigger"],"clientOrderTime":"2020-10-07 14:02:32,877 +0000","orderId":"4820275012","userFullName":"User1@MAIN.pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (stop)","description":"Successful stop order"},"components/examples/orderResponseExampleLimit":{"id":"components/examples/orderResponseExampleLimit","value":{"coId":"Order25","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.0973655,"orderId":"4820275011","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (limit GTC)","description":"Successful limit order"},"components/examples/orderResponseExampleLimitCustomParams":{"id":"components/examples/orderResponseExampleLimitCustomParams","value":{"coId":"8932452311958","type":"Limit","timeInForce":"GTT","side":"Sell","currency":"USD","symbol":"USD/CAD","size":10000,"org":"BrokerOrgB","price\"":1.26963,"expiryTime":3,"clientOrderTime":"2025-07-01 09:39:30,857 +0000","tradeChannel":"API/REST/ESP","orderId":"91698681085","userFullName":"tradingUser@BrokerOrgB","action":"place","status":"RECEIVED","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"summary":"Placed order response (custom parameters)","description":"Successful order with custom parameters returned"},"components/examples/orderResponseExampleLimitIOC":{"id":"components/examples/orderResponseExampleLimitIOC","value":{"coId":"8932452311944","type":"Limit","timeInForce":"IOC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.0971678,"orderId":"4820276016","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (limit IOC)","description":"Successful limit order"},"components/examples/orderResponseExampleLimitIOCFilled":{"id":"components/examples/orderResponseExampleLimitIOCFilled","value":{"coId":"8932452311944","type":"Limit","timeInForce":"IOC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","account":"BrokerOrg1LE5","maxShow":1000000,"averagePrice":1.0971669,"cumQty":1000000,"orderId":"4820276016","userFullName":"User1@pfOrg","action":"place","status":"FILLED"},"summary":"Filled order response (limit IOC)","description":"Filled limit order"},"components/examples/orderResponseExampleAtBest":{"id":"components/examples/orderResponseExampleAtBest","value":{"coId":"1685730661","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"USD","symbol":"USD/INR","size":1000000,"priceType":"NDF","org":"CustomerOrg","clientOrderTime":"2023-06-02 18:31:01,249 +0000","tradeChannel":"API/REST/ESP","orderId":"4892228085","valueDate":"2023-06-15","userFullName":"userName@CustomerOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (at best)","description":"Successful at-best order"},"components/examples/orderResponseExampleAtBestFilled":{"id":"components/examples/orderResponseExampleAtBestFilled","value":{"coId":"1685730661","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"USD","symbol":"USD/INR","size":1000000,"priceType":"NDF","org":"CustomerOrg","account":"CustomerOrgle1","maxShow":1000000,"averagePrice":83.839,"cumQty":1000000,"orderId":"4892228085","valueDate":"2023-06-15","tradeDate":"2023-06-02","userFullName":"userName@CustomerOrg","action":"place","status":"FILLED"},"summary":"Filled order query response (at best)","description":"Filled at-best order"},"components/examples/orderResponseExampleAtBestExpired":{"id":"components/examples/orderResponseExampleAtBestExpired","value":{"coId":"16857304844","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"CustomerOrg","account":"CustomerOrgle1","averagePrice":0,"cumQty":0,"orderId":"4892226279","valueDate":"2023-04-20","tradeDate":"2023-04-19","userFullName":"otherUserName@CustomerOrg","action":"place","status":"EXPIRED"},"summary":"Expired order query response (at best)","description":"Expired at-best order"},"components/examples/orderResponseExampleMarket":{"id":"components/examples/orderResponseExampleMarket","value":{"coId":"Order20","type":"Market","timeInForce":"GTT","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":9000000,"org":"BrokerOrg1","price":1.1864,"expiryTime":35,"orderId":"4820275013","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (market)","description":"Successful market order"},"components/examples/orderResponseExamplePQ":{"id":"components/examples/orderResponseExamplePQ","value":{"coId":"pq11233","type":"PQ","timeInForce":"FOK","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":9000000,"price":1.1652,"rateId":"4HProduct|2022-11-14|0800-1200|EURUSD|SPOT","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (previously quoted)"},"components/examples/orderResponseExampleOnBehalfOf":{"id":"components/examples/orderResponseExampleOnBehalfOf","value":{"coId":"Order25FI34_231233","type":"Limit","timeInForce":"IOC","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.1867,"org":"FI34","account":"FI34_LE","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"summary":"Placed order response (on behalf of)"},"components/examples/orderResponseExampleFAILtype":{"id":"components/examples/orderResponseExampleFAILtype","value":{"coId":"Order61","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275015","action":"place","status":"FAILED"},"summary":"Missing order type"},"components/examples/orderResponseExampleFAILsymbol":{"id":"components/examples/orderResponseExampleFAILsymbol","value":{"coId":"Order61","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275017","action":"place","status":"FAILED","reason":"Incomplete Currency Information"},"summary":"Missing symbol"},"components/examples/orderResponseExampleFAILcoId":{"id":"components/examples/orderResponseExampleFAILcoId","value":{"type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275024","action":"place","status":"FAILED","reason":"Invalid coId, client order id can not be null or blank"},"summary":"Missing client order ID"},"components/examples/orderResponseExampleFAILminSize":{"id":"components/examples/orderResponseExampleFAILminSize","value":{"coId":"OrderSmall2","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275133","action":"place","status":"FAILED","reason":"RequestValidationError.OrderAmount.LessThanAllowed"},"summary":"Order size too small","description":"Failed order. Requested size less than min order size"},"components/examples/orderResponseExampleFAILmaxSize":{"id":"components/examples/orderResponseExampleFAILmaxSize","value":{"coId":"OrderLarge62","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10000000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275246","action":"place","status":"FAILED","reason":"RequestValidationError.OrderAmount.MoreThanAllowed"},"summary":"Order size too large","description":"Failed order. Requested size greater than max order size"},"components/examples/orderResponseExampleFAILrateMismatch":{"id":"components/examples/orderResponseExampleFAILrateMismatch","value":{"coId":"Order63","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10000000000,"org":"BrokerOrg1","price":1.1867,"rateId":"2022-11-14-EURUSD-SPOT-435ef88474","orderId":"4820279844","action":"place","status":"FAILED","reason":"RequestValidationError.DeliverToCompIDSetup"},"summary":"Rate not found"},"components/examples/orderResponseExampleREJECTED":{"id":"components/examples/orderResponseExampleREJECTED","value":{"coId":"req84","type":"Limit","timeInForce":"FOK","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":9000000,"org":"pfOrg","account":"pfOrg","price":1.1,"stopPrice":0,"minQty":0,"maxShow":9000000,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4837081000","tradeDate":"2022-06-23","userFullName":"user1@pfOrg","action":"place","status":"REJECTED","reason":"RequestValidationError.OrderAmount.MoreThanAllowed"},"summary":"Order rejected","description":"Order rejected during business validation."},"components/examples/orderResponseExampleCancelPending":{"id":"components/examples/orderResponseExampleCancelPending","value":{"coId":"order9","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"SanityOrg","account":"SanityOrgLE","stopPrice":0,"minQty":0,"maxShow":1000000,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4795143575","action":"place","status":"PENDING_CANCEL"},"summary":"Canceled order pending","description":"Order with request to cancel received."},"components/examples/orderResponseExampleCanceled":{"id":"components/examples/orderResponseExampleCanceled","value":{"coId":"order9","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"SanityOrg","price":0.3,"averagePrice":0,"cumQty":0,"orderId":"4795143575","executionType":"Pending Cancel","leavesQty":1000000,"action":"place","status":"CANCELED"},"summary":"Canceled order","description":"Canceled order no longer active."},"components/examples/spotRate":{"id":"components/examples/spotRate","value":{"symbol":"EUR/USD","bid":1.1863,"offer":1.18638,"bidLimit":1000000,"offerLimit":1000000,"time":1602536120080,"rateId":"2022-11-10-EURUSD-SPOT-435ef73249"},"summary":"A spot rate object with top-of-book spot rates."},"components/examples/refDataSymbolCurrencyPair":{"id":"components/examples/refDataSymbolCurrencyPair","value":{"instrument":"EUR/USD","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},"summary":"Quoting details for a currency pair."},"components/examples/refDataSymbolCurrencyPairList":{"id":"components/examples/refDataSymbolCurrencyPairList","value":[{"instrument":"EUR/USD","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrumen\"":"EUR/AED","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrument":"XAU/GBP","spotPrecision":3,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":5,"pipsFactor":100,"instrumentType":"METAL","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrument":"EUR/GBP","spotPrecision":6,"spotPointsPrecision":2,"forwardPointsPrecision":0,"forwardRatePrecision":6,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"}],"summary":"All symbols in the system."},"components/examples/refDataInstrumentCurrency":{"id":"components/examples/refDataInstrumentCurrency","value":{"shortName":"USD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue\"":0.01},"summary":"Quoting details for a currency."},"components/examples/refDataInstrumentCurrencyList":{"id":"components/examples/refDataInstrumentCurrencyList","value":[{"shortName":"USD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue\"":0.01},{"shortName":"US1","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"HKD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"PHX","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"IOT","instrumentType":"CRYPTO","roundingType":"ROUND_HALF_UP","tickValue":1},{"shortName":"XAG","instrumentType":"METAL","roundingType":"ROUND_HALF_UP","tickValue":0.001}],"summary":"All instruments supported by the calling organization."},"components/examples/rfsAccepted":{"id":"components/examples/rfsAccepted","value":{"clOrderId":"view1MultiLP8","requestId":"G4796976d512eg341786e1f234","transactionId":"FXI9218763489","ttl":112,"event":"REQUEST_ACCEPTED"},"summary":"REQUEST_ACCEPTED"},"components/examples/rfsDeclined":{"id":"components/examples/rfsDeclined","value":{"clOrderId":"view1MultiLP7","requestId":"G4796976d517b1786esdf3454","event":"REQUEST_DECLINED","reason":"User does not have permissions."},"summary":"REQUEST_DECLINED"},"components/examples/rfsRejected":{"id":"components/examples/rfsRejected","value":{"clOrderId":"view1MultiLP6","requestId":"G4796976d517b1786e1f3453","transactionId":"FXI9218675295","ttl":111,"event":"TRADE_REJECTED"},"summary":"TRADE_REJECTED"},"components/examples/rfsCancelled":{"id":"components/examples/rfsCancelled","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_WITHDRAWN"},"summary":"REQUEST_WITHDRAWN"},"components/examples/rfsExpired":{"id":"components/examples/rfsExpired","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1sstb2h5ye1fa","transactionId":"FXI9218602325","ttl":40,"event":"REQUEST_EXPIRED"},"summary":"REQUEST_EXPIRED"},"components/examples/rfsInitial":{"id":"components/examples/rfsInitial","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_RECEIVED"},"summary":"REQUEST_RECEIVED"},"components/examples/rfsQuotedFwdFwd":{"id":"components/examples/rfsQuotedFwdFwd","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":40,"event":"QUOTE","quotes":[{"requestId":"G4796976d517b17818a0021e","priceType":"FwdFwd","effectiveTime":0,"symbol":"EUR/USD","ttl":111,"dealtCurrency":"EUR","status":"A","nearValueDate":"2023-04-07","farValueDate":"2023-04-19","bids":[{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1199.92,"provider":"ProvB","rate":1.19992,"spotRate":1.19972,"forwardPoint":0.0002,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1469.34,"provider":"Prov1A","rate":1.46934,"spotRate":1.46924,"forwardPoint":0.0001,"midRate":1.47014},{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1187.43,"provider":"ProvB","rate":1.18743,"spotRate":1.18763,"forwardPoint":-0.0002,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1470.54,"provider":"SGX","rate":1.47054,"spotRate":1.47074,"forwardPoint":-0.0002,"midRate":1.46984}],"offers":[{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1199.62,"provider":"ProvB","rate":1.19962,"spotRate":1.19972,"forwardPoint":-0.0001,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1469.14,"provider":"Prov1A","rate":1.46914,"spotRate":1.46924,"forwardPoint":-0.0001,"midRate":1.46984},{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1187.73,"provider":"ProvB","rate":1.18773,"spotRate":1.18763,"forwardPoint":0.0001,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1470.94,"provider":"Prov1A","rate":1.47094,"spotRate":1.47074,"forwardPoint":0.0002,"midRate":1.47014}]}]},"summary":"QUOTE (forward/forward swap)"},"components/examples/rfsQuotedOutright":{"id":"components/examples/rfsQuotedOutright","value":{"clOrderId":"rjv_566","requestId":"G4796976d5_228bd_19587256c877","transactionId":"FXI9445344076","ttl":7200,"event":"QUOTE","quotes":[{"requestId":"G4796976d5_228bd_19587256c877","priceType":"Outright","effectiveTime":0,"symbol":"USD/CAD","ttl":7200,"dealtCurrency":"USD","status":"A","nearValueDate":"2025-03-19","bids":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"BID","dealtAmount":1000,"settledAmount":1347.77,"provider":"ProvOrgA","rate":1.34777,"spotRate":1.34767,"forwardPoint":0.0001,"midRate":0}],"offers":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"OFFER","dealtAmount":1000,"settledAmount":1349.87,"provider":"ProvOrgA","rate":1.34987,"spotRate":1.34967,"forwardPoint":0.0002,"midRate":0}]}]},"summary":"QUOTE (outright)"},"components/examples/rfsExecuted":{"id":"components/examples/rfsExecuted","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"TRADE_VERIFIED","trades":[{"orderId":"FXI9219477338","tradeId":"FXI9219477338","tradeType":"FwdFwd","tradeDate":"2022-02-04","valueDate":"2022-02-07","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"pfOrg","customerOrg":"pfOrg","trader":"user1","counterparty":"BRK1","cptyLongName":"BRK1","cptyTradeId":"ASX100123-v","counterPartyAccount":"BRK1","farValueDate":"2022-02-16","farSide":"Buy","externalRequestId":"rfs11","requestId":"G4796976d517ec6108f3ef1f","benchmarkRate":0,"farLegISIN":"EZ8SM8VRH1L0","nearLegISIN":"EZW51H6Z01T4","dealtAmount":1000000,"settledAmount":1186740,"baseAmount":1000000,"termAmount":1186740,"spotRate":1.18644,"rate":1.186443,"forwardPoints":0.000003,"swapPoints":0.000001,"farRate":1.186444,"farDealtAmount":2000000,"farSettledAmount":2373790,"farBaseAmount":2000000,"farTermAmount":2373790,"farForwardPoints":0.000004,"upi":"EUR_USD_SWAP","uti":"MCQRZU5ST1INP9219477338","midMarket":false}]},"summary":"TRADE_VERIFIED"},"components/examples/rfsRequestQuoteSuccess":{"id":"components/examples/rfsRequestQuoteSuccess","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b17818a0021e","event":"REQUEST_RECEIVED"},"summary":"REQUEST_RECEIVED"},"components/examples/rfsPending":{"id":"components/examples/rfsPending","value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1sstb2h5ye111","transactionId":"FXI9218602325","ttl":40,"event":"TRADE_PENDING"},"summary":"TRADE_PENDING"},"components/examples/rfsRequestExampleRFS":{"id":"components/examples/rfsRequestExampleRFS","value":{"clOrderId":"view1MultiLP5","symbol":"EUR/USD","amount":1000000,"dealtCurrency":"EUR","expiry":140,"nearValueDate":"1W","farDealtAmount":1000000,"farValueDate":"2W","side":"TWO_WAY","priceType":"FwdFwd","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"]},"summary":"Request RFS (forward-forward)"},"components/examples/rfsRequestExampleRFSCustomParams":{"id":"components/examples/rfsRequestExampleRFSCustomParams","value":{"clOrderId":"view1MultiLP5","symbol":"EUR/USD","amount":1000000,"dealtCurrency":"EUR","expiry":140,"nearValueDate":"1W","farDealtAmount":1000000,"farValueDate":"2W","side":"TWO_WAY","priceType":"FwdFwd","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"],"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"summary":"Request RFS (forward-forward, custom params)"},"components/examples/rfsRequestExampleRFQ":{"id":"components/examples/rfsRequestExampleRFQ","value":{"clOrderId":"quote-EURUSD-578-5min","symbol":"EUR/USD","amount":500000,"dealtCurrency":"USD","expiry":600,"rfq":true,"nearValueDate":"2025-03-25","side":"TWO_WAY","priceType":"Spot","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"]},"summary":"Request RFQ (spot)"},"components/examples/rfsRequestExampleRFQCustomParams":{"id":"components/examples/rfsRequestExampleRFQCustomParams","value":{"clOrderId":"quote-EURUSD-578-5min","symbol":"EUR/USD","amount":500000,"dealtCurrency":"USD","expiry":600,"rfq":true,"nearValueDate":"2025-03-25","side":"TWO_WAY","priceType":"Spot","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"],"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"summary":"Request RFQ (spot, customer params)"},"components/examples/rfsAcceptRequestBodyRfs":{"id":"components/examples/rfsAcceptRequestBodyRfs","value":{"quoteId":"G-4796976cf-17b1781b062","side":"BUY","symbol":"GBP/USD","dealtCurrency":"USD","clOrderId":"view1MultiLP5"},"summary":"RFS accept"},"components/examples/rfsAcceptRequestBodyRfq":{"id":"components/examples/rfsAcceptRequestBodyRfq","value":{"quoteId":"G-4796976cf-17b1781ef16","side":"SELL","symbol":"EUR/USD","dealtCurrency":"USD","transactionId":"FXI28550024","clOrderId":"Sell-EuroQuote-5min","rfq":true},"summary":"RFQ accept"},"components/examples/position":{"id":"components/examples/position","value":[{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-11","level":"ORG","levelValue":"pfOrg","netOpenBase":200000,"netOpenterm":237278,"rate":1.18639,"realizedPnL":0,"unrealizedPnL":-22,"pnlCurrency":"USD"},{"side":"Short","symbol":"EUR/USD","valueDate":"2022-03-18","level":"ORG","levelValue":"pfOrg","netOpenBase":5000000,"netOpenterm":5933600,"rate":1.18672,"realizedPnL":0,"unrealizedPnL":1600,"pnlCurrency":"USD"},{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-25","level":"ORG","levelValue":"pfOrg","netOpenBase":10000000,"netOpenterm":11865200,"rate":1.18652,"realizedPnL":0,"unrealizedPnL":-2400,"pnlCurrency":"USD"},{"symbol":"EUR/USD","valueDate":"2022-03-23","level":"ORG","levelValue":"pfOrg","netOpenBase":0,"netOpenterm":0,"realizedPnL":-280,"unrealizedPnL":0,"pnlCurrency":"USD"}],"summary":"List of positions"},"components/examples/tradeStpSpotFromLimit":{"id":"components/examples/tradeStpSpotFromLimit","value":[{"orderId":"4820276016","tradeId":"FXI9369258100","tradeType":"Spot","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"BrokerOrg1","counterpartyLongName":"The Broker Org","counterpartyAccount":"BrokerOrg1LE5","coId":"8932452311944","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097166.9,"baseAmount":1000000,"termAmount":1097166.9,"spotRate":1.0971669,"rate":1.0971669,"event":"NEW","channelCategory":"API","upi":"EUR_USD_SPOT","uti":"1234567890AQUSUUINP9349138130"}],"summary":"Spot from limit order, taker download","description":"STP download of trade to fill limit order request"},"components/examples/tradeStpSpotFromLimitCustomParams":{"id":"components/examples/tradeStpSpotFromLimitCustomParams","value":[{"orderId":"4820276016","tradeId":"FXI9369258100","tradeType":"Spot","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"BrokerOrg1","counterpartyLongName":"The Broker Org","counterpartyAccount":"BrokerOrg1LE5","coId":"8932452311944","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097166.9,"baseAmount":1000000,"termAmount":1097166.9,"spotRate":1.0971669,"rate":1.0971669,"event":"NEW","channelCategory":"API","upi":"EUR_USD_SPOT","uti":"1234567890AQUSUUINP9349138130","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}}],"summary":"Spot from limit order, taker download, custom parameters","description":"STP download of trade to fill limit order request with custom parameters"},"components/examples/tradeStpSpot":{"id":"components/examples/tradeStpSpot","value":[{"orderId":"4829069175","tradeId":"FXI9232048063","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650554289719","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:18:09,875 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"NEW","upi":"EUR_USD_SPOT","usi":"MCQRZU5ST1INP9232048063"},{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32,413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"RESEND","upi":"EUR_USD_SPOT","usi":"MCQRZU5ST1INP9232048066"}],"summary":"Spot, taker download","description":"STP download received by TAKER"},"components/examples/tradeStpResend":{"id":"components/examples/tradeStpResend","value":[{"orderId":"4829069175","tradeId":"FXI9232048063","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650554289719","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:18:09875 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"RESEND","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048063"},{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"RESEND","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048066"}],"summary":"Resend, spot, taker download","description":"STP download received by TAKER"},"components/examples/tradeStpCustOutright":{"id":"components/examples/tradeStpCustOutright","value":[{"orderId":"4892228085","tradeId":"FXI9349138130","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"CptyOrg","counterpartyLongName":"CptyOrg","counterpartyAccount":"CptyOrgLE1","coId":"1685730661","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","channelCategory":"API","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349138130"}],"summary":"Customer trade, outright, taker download","description":"STP download received by TAKER"},"components/examples/tradeResponseQueryByTradeId":{"id":"components/examples/tradeResponseQueryByTradeId","value":{"orderId":"4820926010","tradeId":"FXI9222877182","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-03-01","valueDate":"2022-03-03","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"pfOrg","customerOrg":"pfOrg","trader":"DealerUser","counterparty":"CptyA","cptyLongName":"Counterparty A","coverTradeIds":["FXI9222877182C"],"cptyTradeId":"FXI9222877182C","counterpartyAccount":"CptyA_LE","channel":"API/REST/ESP","externalRequestId":"Spot3442","benchmarkRate":0,"dealtAmount":1000000,"settledAmount":1186310,"baseAmount":1000000,"termAmount":1186310,"spotRate":1.18631,"rate":1.18631,"fees":0,"initialSettledAmount":1186310,"midMarket":false,"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9222877182"},"summary":"Trade by trade ID","description":"Done trade returned from query by trade ID"},"components/examples/tradeResponseQueryByTradeIdCustomParams":{"id":"components/examples/tradeResponseQueryByTradeIdCustomParams","value":{"orderId":"FXI4406311106","tradeId":"FXI4406311106","tradeType":"Spot","tenor":"Spot","tradeDate":"2025-07-01","valueDate":"2025-07-03","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","rateid":"G-479697b30-197c51c2818-WFNAD-d8846","customerAccount":"BrokerCustomerOrg_LE","customerOrg":"BrokerCustomerOrg","trader":"traderUser","counterParty":"BrokerOrg","cptyLongName":"Broker Dealer Org","coverTradeIds":[],"cptyTradeId":"","counterPartyAccount":"BrokerOrg","counterpartyBLEI":"BrokerOrgLEI1234342343242","externalRequestId":"req26","channel":"API/REST/RFS","executionTime":"2025-07-01 08:33:20,136 +0000","dealtAmount":1000000,"settledAmount":1275420,"baseAmount":1000000,"termAmount":1275420,"spotRate":1.27542,"rate":1.27542,"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"summary":"Trade by trade ID w/ custom params","description":"Done trade with custom parameters returned from query by trade ID"},"components/examples/tradeAmendRequest":{"id":"components/examples/tradeAmendRequest","value":{"id":"FXI9271593184","spotRate":1.18631,"dealtAmount":21000,"customerAccount":"BrokerCustOrg1le1","forwardPoints":0.0001,"note":"Sales: done after cover"},"summary":"Amend a trade","description":"Amend a trade by customer, rate, and amount."},"components/examples/tradeRollRequest":{"id":"components/examples/tradeRollRequest","value":{"id":"FXI9339324216","forwardPoints":0.0002,"valueDate":"2024-10-05","note":"Daily roll"},"summary":"Roll a trade","description":"Roll a trade to a forward date."},"components/examples/tradeRollRequestNDF":{"id":"components/examples/tradeRollRequestNDF","value":{"id":"FXI9339324216","forwardPoints":0.0002,"valueDate":"2024-10-05","fixingDate":"2024-10-05","note":"Daily roll"},"summary":"Roll an NDF trade","description":"Roll an NDF trade to a forward date."},"components/examples/tradeAllocateRequest":{"id":"components/examples/tradeAllocateRequest","value":{"id":"FXI9270827222","allocations":[{"referenceId":"A123451","allocationAmount":3000000,"side":"BUY","customerAccount":"BrokerCustOrg1le1","note":"Netting out BankA trades"},{"referenceId":"A123452","allocationAmount":9000000,"side":"SELL","customerAccount":"BrokerCustOrg1le2","note":"Netting out BankA trades"}]},"summary":"Allocate a trade","description":"Divide a trade amongst multiple organizations."},"components/examples/tradeCancelRequestTradeId":{"id":"components/examples/tradeCancelRequestTradeId","value":{"customerOrg":"BrokerCustOrgDle5","tradeId":"FXI73879011"},"summary":"Cancel a trade (tradeId)","description":"Cancel a single trade by trade ID."},"components/examples/tradeCancelRequestClientRequestId":{"id":"components/examples/tradeCancelRequestClientRequestId","value":{"customerOrg":"BrokerCustOrgDle5","clientRequestId":"A123452_C1_Cover_A123339"},"summary":"Cancel a trade (clientRequestId)","description":"Cancel one or more trades by your trade request ID."},"components/examples/tradeStpCustCoverOutright":{"id":"components/examples/tradeStpCustCoverOutright","value":[{"orderId":"4892228085","tradeId":"FXI9349138130","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":true,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"CptyOrg","counterpartyLongName":"CptyOrg","counterpartyAccount":"le1codeAtCptyOrg","coId":"1685730661","channel":"API/REST/RFS","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","coverRate":1.0966372,"coverSpotRate":1.09643,"coverForwardPoints":0.0002072,"spreads":{"pmPreSpotSpread":0.0005,"pmSpotSpread":0.0005},"coverRiskManagementType":"COVER","channelCategory":"API","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349138130"},{"orderId":"FXI9349101537","tradeId":"FXI9349101537","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"le1codeAtCptyOrg","customerOrg":"CptyOrg","user":"CptyOrgQuoter@CptyOrg","counterparty":"LPOrg","counterpartyLongName":"LP Org Full Name","counterpartyTradeId":"FXI9349101537","counterpartyAccount":"LPOrgCodeAtCptyOrg","counterpartyLEI":"O2RNE8IBXP4R0TD8PU41","coId":"FXI9349138130","channel":"BA/RFS","executionTime":"2023-06-02 18:31:02,336 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","channelCategory":"COVER","coveredTradeId":"FXI9349138130","coveredCounterparty":"CustomerOrg","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349101537","MT300Field72":"/CMS/Default"}],"summary":"Customer and cover trade, outright, maker download","description":"STP download received by MAKER"},"components/examples/tradeStpCustCover":{"id":"components/examples/tradeStpCustCover","value":[{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"NEW","coverRate":1.09691,"coverSpotRate":1.09691,"spreads":{"ppSpotSpread":0.00055,"ppCustSpread":0.00055},"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048066"},{"orderId":"4829108080","tradeId":"FXI9232111143","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA_LE1","customerOrg":"BrokerA","user":"jk1@BrokerA","counterparty":"CustB","counterpartyLongName":"Customer B","counterpartyAccount":"CustB-le","counterpartyLEI":"CustB-LEI","coId":"FXI9232048066","channel":"BA/ESP","executionTime":"2022-04-21 15:33:32417 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"NEW","coveredTradeId":"FXI9232048066","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232111143"}],"summary":"Customer and cover trade, spot, maker download","description":"STP download received by MAKER"},"paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example":{"value":{"user":"apiUserId","pass":"This is a long password!","org":"apiOrganizationId"},"id":"paths/~1v2~1sso~1login/post/requestBody/content/application~1json/example"},"paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example":{"value":{"status":"OK","errorCode":null,"responseTuples":null,"expiryTime":1665490480729,"serverUTCTime":1665490420730},"id":"paths/~1v2~1sso~1login/post/responses/200/content/application~1json/example"},"paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example":{"value":{"status":"OK","valid":true,"expiryTime":1603829916338,"apiVersion":"1.0","expired":false},"id":"paths/~1v2~1sso~1token~1renew/get/responses/200/content/application~1json/example"},"paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate":{"value":{"symbol":"EUR/USD","bid":1.1863,"offer":1.18638,"bidLimit":1000000,"offerLimit":1000000,"time":1602536120080,"rateId":"2022-11-10-EURUSD-SPOT-435ef73249"},"key":"spotRate","summary":"A spot rate object with top-of-book spot rates.","id":"paths/~1v2~1rates~1spot/get/responses/200/content/application~1json/examples/spotRate"},"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates":{"value":{"symbol":"EUR/USD","bid":1.1863,"offer":1.18638,"bidLimit":1000000,"offerLimit":1000000,"time":1602536120080,"rateId":"2022-11-10-EURUSD-SPOT-435ef73249"},"key":"top-of-bookRates","summary":"Top-of-book rates","id":"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/top-of-bookRates"},"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers":{"value":{"symbol":"EUR/USD","bid":[1.1863,1.18627,1.18626],"offer":[1.18638,1.1864,1.18641],"bidLimit":[1000000,2000000,3000000],"offerLimit":[1000000,2000000,3000000],"time":1602535935011,"rateId":"2022-11-10-EURUSD-SPOT-435ef32498"},"key":"full-bookRateTiers","summary":"Full-book rates","id":"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/full-bookRateTiers"},"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates":{"value":{"symbol":"EUR/USD","bid":[1.1863,1.18627,1.18626],"offer":[1.18638,1.1864,1.18641],"bidLimit":[1000000,2000000,3000000],"offerLimit":[1000000,2000000,3000000],"bidProviders":["LP1","LP2","LP3"],"offerProviders":["LP2","LP3","LP1"],"time":1602535934006,"rateId":"2022-11-10-EURUSD-SPOT-435ef12309"},"key":"rawRates","summary":"Raw rates","id":"paths/~1v2~1rates~1spot~1{type}/get/responses/200/content/application~1json/examples/rawRates"},"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates":{"value":{"symbol":"EUR/USD","bid":1.1863,"offer":1.18638,"bidLimit":1000000,"offerLimit":1000000,"time":1602536120080,"rateId":"2022-11-10-EURUSD-SPOT-435ef73249"},"key":"top-of-bookRates","summary":"Top-of-book rates","id":"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/top-of-bookRates"},"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers":{"value":{"symbol":"EUR/USD","bid":[1.1863,1.18627,1.18626],"offer":[1.18638,1.1864,1.18641],"bidLimit":[1000000,2000000,3000000],"offerLimit":[1000000,2000000,3000000],"time":1602535935011,"rateId":"2022-11-10-EURUSD-SPOT-435ef32498"},"key":"full-bookRateTiers","summary":"Full-book rates","id":"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/full-bookRateTiers"},"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates":{"value":{"symbol":"EUR/USD","bid":[1.1863,1.18627,1.18626],"offer":[1.18638,1.1864,1.18641],"bidLimit":[1000000,2000000,3000000],"offerLimit":[1000000,2000000,3000000],"bidProviders":["LP1","LP2","LP3"],"offerProviders":["LP2","LP3","LP1"],"time":1602535934006,"rateId":"2022-11-10-EURUSD-SPOT-435ef12309"},"key":"rawRates","summary":"Raw rates","id":"paths/~1v2~1rates~1spot~1{type}~1{org}/get/responses/200/content/application~1json/examples/rawRates"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate":{"value":[{"id":"RealTimeMDS","date":null,"timeWindow":null,"name":"Real-time market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":null,"currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"}]}],"key":"realTimeMarketDataSetWithOneRate","summary":"Real-time market data set with one rate","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithOneRate"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates":{"value":[{"id":"RealTimeMDS","date":null,"timeWindow":null,"name":"Real-time market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":null,"currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":null,"tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":144.34,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"key":"realTimeMarketDataSetWithMultipleRates","summary":"Real-time market data set with multiple rates","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/realTimeMarketDataSetWithMultipleRates"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate":{"value":[{"id":"EODMDS","date":"2024-11-14","timeWindow":null,"name":"End-of-day market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"}]}],"key":"eodMarketDataSetWithOneRate","summary":"End-of-day market data set with one rate","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithOneRate"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates":{"value":[{"id":"EODMDS","date":"2024-11-05","timeWindow":null,"name":"End-of-day market data","createdTime":null,"activationTime":null,"validUntil":null,"nextCreationTime":null,"expirationTime":null,"rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":1.07992,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e313","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":144.34,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"key":"eodMarketDataSetWithMultipleRates","summary":"End-of-day market data set with multiple rates","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/eodMarketDataSetWithMultipleRates"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate":{"value":[{"id":"FixedPeriodMDS","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.07863,"mid":null,"offer":1.08121,"baseCurrency":"EUR","termCurrency":"USD"}]}],"key":"fixedMarketDataSetWithOneRate","summary":"Fixed-period market data set with one rate","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithOneRate"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates":{"value":[{"id":"FixedPeriodMDS4H","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e321","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":null,"tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"M-FP.G4796976cb_83b6d__17fe1871243_1e313","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"key":"fixedMarketDataSetWithMultipleRates","summary":"Fixed-period market data set with multiple rates","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleRates"},"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS":{"value":[{"id":"FixedPeriodMDS4H","date":"2024-11-14","timeWindow":"0850-1200","name":"4HProduct MDS","createdTime":"2024-11-14 08:40:00,000 +0000","activationTime":"2024-11-14 08:50:00,000 +0000","validUntil":"2024-11-14 12:00:00,000 +0000","nextCreationTime":"2024-11-14 11:50:00,000 +0000","rates":[{"status":"OK","rateId":"R_17fec871243_1e32a","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1632,"mid":null,"offer":1.1652,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"OK","rateId":"R_17fec878bef3_10947","tenor":"SPOT","currencyPair":"AUD/CAD","bid":0.9141,"mid":null,"offer":0.9148,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"R_17fec871243_1e2f3","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]},{"id":"FixedPeriodMDS4H_AR2","date":"2024-11-14","timeWindow":"1200-1600","name":"4HProduct MDS second session","createdTime":"2024-11-14 11:50:00,000 +0000","activationTime":"2024-11-14 12:00:00,000 +0000","validUntil":"2024-11-14 16:00:00,000 +0000","nextCreationTime":"2024-11-14 15:50:00,000 +0000","rates":[{"status":"OK","rateId":"Rf_17fec80001_1ce33","currencyPair":"EUR/USD","tenor":"SPOT","bid":1.1634,"mid":null,"offer":1.1653,"baseCurrency":"EUR","termCurrency":"USD"},{"status":"NO_RATE","rateId":"Rf_17fec8040b_1ce62","tenor":"SPOT","currencyPair":"AUD/CAD","bid":0,"mid":0,"offer":0,"baseCurrency":"AUD","termCurrency":"CAD"},{"status":"OK","rateId":"Rf_17fec803b2_1bb85","tenor":"SPOT","currencyPair":"USD/JPY","bid":143.23,"mid":null,"offer":145.45,"baseCurrency":"USD","termCurrency":"JPY"}]}],"key":"fixedMarketDataSetWithMultipleMDS","summary":"Multiple fixed-period market data sets","id":"paths/~1v2~1marketdataset/get/responses/200/content/application~1json/examples/fixedMarketDataSetWithMultipleMDS"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC":{"value":{"coId":"8932452311944","type":"Limit","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.0971678,"timeInForce":"IOC"},"key":"placeLimitIOC","summary":"Place limit order (IOC)","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitIOC"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit":{"value":{"coId":"Order25","type":"Limit","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.0973655,"timeInForce":"GTC"},"key":"placeLimit","summary":"Place limit order (GTC)","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimit"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams":{"value":{"coId":"8932452311958","type":"Limit","side":"Sell","symbol":"USD/CAD","currency":"USD","size":10000,"price":1.26963,"timeInForce":"GTT","expiryTime":"3","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"key":"placeLimitCustomParams","summary":"Place limit order w/ custom params","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeLimitCustomParams"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest":{"value":{"coId":"1685730661","type":"AtBest","side":"Buy","symbol":"USD/INR","currency":"USD","size":1000000,"priceType":"NDF","timeInForce":"FOK","org":"CustomerOrg","valueDate":"2023-06-15"},"key":"placeAtBest","summary":"Place at best order","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeAtBest"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket":{"value":{"coId":"Order20","type":"Market","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":9000000,"price":1.1864,"timeInForce":"IOC"},"key":"placeMarket","summary":"Place market order (IOC)","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeMarket"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop":{"value":{"coId":"Stop11","type":"Stop","timeInForce":"GTC","side":"Sell","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.19353,"stopPrice":1.19353,"execFlags":["BidTrigger"]},"key":"placeStop","summary":"Place stop order (GTC)","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeStop"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted":{"value":{"coId":"pq11233","rateId":"4HProduct|2022-11-14|0800-1200|EURUSD|SPOT","currency":"EUR","size":9000000,"type":"PQ","price":1.1652,"side":"Buy","symbol":"EUR/USD","timeInForce":"FOK"},"key":"placePreviouslyQuoted","summary":"Place previously quoted order","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placePreviouslyQuoted"},"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf":{"value":{"coId":"Order25FI34_231233","type":"Limit","timeInForce":"IOC","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.1867,"org":"FI34","account":"FI34_LE"},"key":"placeOnBehalfOf","summary":"Place on behalf of order","id":"paths/~1v2~1orders/post/requestBody/content/application~1json/examples/placeOnBehalfOf"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC":{"value":{"coId":"8932452311944","type":"Limit","timeInForce":"IOC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.0971678,"orderId":"4820276016","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseLimitIOC","summary":"Placed order response (limit IOC)","description":"Successful limit order","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitIOC"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit":{"value":{"coId":"Order25","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.0973655,"orderId":"4820275011","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseLimit","summary":"Placed order response (limit GTC)","description":"Successful limit order","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimit"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas":{"value":{"coId":"8932452311958","type":"Limit","timeInForce":"GTT","side":"Sell","currency":"USD","symbol":"USD/CAD","size":10000,"org":"BrokerOrgB","price\"":1.26963,"expiryTime":3,"clientOrderTime":"2025-07-01 09:39:30,857 +0000","tradeChannel":"API/REST/ESP","orderId":"91698681085","userFullName":"tradingUser@BrokerOrgB","action":"place","status":"RECEIVED","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"key":"responseLimitCustomParas","summary":"Placed order response (custom parameters)","description":"Successful order with custom parameters returned","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseLimitCustomParas"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest":{"value":{"coId":"1685730661","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"USD","symbol":"USD/INR","size":1000000,"priceType":"NDF","org":"CustomerOrg","clientOrderTime":"2023-06-02 18:31:01,249 +0000","tradeChannel":"API/REST/ESP","orderId":"4892228085","valueDate":"2023-06-15","userFullName":"userName@CustomerOrg","action":"place","status":"RECEIVED"},"key":"responseAtBest","summary":"Placed order response (at best)","description":"Successful at-best order","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseAtBest"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket":{"value":{"coId":"Order20","type":"Market","timeInForce":"GTT","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":9000000,"org":"BrokerOrg1","price":1.1864,"expiryTime":35,"orderId":"4820275013","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseMarket","summary":"Placed order response (market)","description":"Successful market order","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseMarket"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop":{"value":{"coId":"Stop11","type":"Stop","rateId":"M-FP.G479697b2e_99cf1__17fc06ddda2_55ba","timeInForce":"GTC","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.19353,"stopPrice":1.19353,"execFlags":["BidTrigger"],"clientOrderTime":"2020-10-07 14:02:32,877 +0000","orderId":"4820275012","userFullName":"User1@MAIN.pfOrg","action":"place","status":"RECEIVED"},"key":"responseStop","summary":"Placed order response (stop)","description":"Successful stop order","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseStop"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ":{"value":{"coId":"pq11233","type":"PQ","timeInForce":"FOK","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":9000000,"price":1.1652,"rateId":"4HProduct|2022-11-14|0800-1200|EURUSD|SPOT","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responsePQ","summary":"Placed order response (previously quoted)","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responsePQ"},"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf":{"value":{"coId":"Order25FI34_231233","type":"Limit","timeInForce":"IOC","side":"Buy","symbol":"EUR/USD","currency":"EUR","size":1000000,"price":1.1867,"org":"FI34","account":"FI34_LE","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseOnBehalf","summary":"Placed order response (on behalf of)","id":"paths/~1v2~1orders/post/responses/202/content/application~1json/examples/responseOnBehalf"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected":{"value":{"coId":"req84","type":"Limit","timeInForce":"FOK","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":9000000,"org":"pfOrg","account":"pfOrg","price":1.1,"stopPrice":0,"minQty":0,"maxShow":9000000,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4837081000","tradeDate":"2022-06-23","userFullName":"user1@pfOrg","action":"place","status":"REJECTED","reason":"RequestValidationError.OrderAmount.MoreThanAllowed"},"key":"rejected","summary":"Order rejected","description":"Order rejected during business validation.","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/rejected"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType":{"value":{"coId":"Order61","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275015","action":"place","status":"FAILED"},"key":"missingType","summary":"Missing order type","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingType"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol":{"value":{"coId":"Order61","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275017","action":"place","status":"FAILED","reason":"Incomplete Currency Information"},"key":"missingSymbol","summary":"Missing symbol","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingSymbol"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId":{"value":{"type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275024","action":"place","status":"FAILED","reason":"Invalid coId, client order id can not be null or blank"},"key":"missingCoId","summary":"Missing client order ID","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/missingCoId"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize":{"value":{"coId":"OrderSmall2","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275133","action":"place","status":"FAILED","reason":"RequestValidationError.OrderAmount.LessThanAllowed"},"key":"requestedSizeLessThanMinOrderSize","summary":"Order size too small","description":"Failed order. Requested size less than min order size","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeLessThanMinOrderSize"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize":{"value":{"coId":"OrderLarge62","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10000000000,"org":"BrokerOrg1","price":1.1867,"orderId":"4820275246","action":"place","status":"FAILED","reason":"RequestValidationError.OrderAmount.MoreThanAllowed"},"key":"requestedSizeGreaterThanMaxOrderSize","summary":"Order size too large","description":"Failed order. Requested size greater than max order size","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/requestedSizeGreaterThanMaxOrderSize"},"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch":{"value":{"coId":"Order63","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":10000000000,"org":"BrokerOrg1","price":1.1867,"rateId":"2022-11-14-EURUSD-SPOT-435ef88474","orderId":"4820279844","action":"place","status":"FAILED","reason":"RequestValidationError.DeliverToCompIDSetup"},"key":"pQOrderRateIdDoesNotMatch","summary":"Rate not found","id":"paths/~1v2~1orders/post/responses/400/content/application~1json/examples/pQOrderRateIdDoesNotMatch"},"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId":{"value":[{"coId":"Order25","type":"Limit","timeInForce":"DAY","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.1993,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4860875001","tradeDate":"2022-10-11","userFullName":"user1@pfgOrg","action":"place","status":"NEW"}],"key":"orderByCoId","summary":"coId included, active order, limit","id":"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoId"},"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled":{"value":[{"coId":"dOrder6","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"CustOrgName","account":"CustOrgAccountName","price":1.09551879,"averagePrice":1.09551879,"cumQty":1000000,"orderId":"1576739500","tradeDate":"2023-04-19","valueDate":"2023-04-20","userFullName":"user@CustOrgName","action":"place","status":"FILLED"}],"key":"orderByCoIdFilled","summary":"coId included, filled order, at best","id":"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdFilled"},"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled":{"value":[{"coId":"order9","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"SanityOrg","price":0.3,"averagePrice":0,"cumQty":0,"orderId":"4795143575","executionType":"Pending Cancel","leavesQty":1000000,"action":"place","status":"CANCELED"}],"key":"orderByCoIdCanceled","summary":"coId included, canceled order, limit","id":"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/orderByCoIdCanceled"},"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId":{"value":[{"coId":"Order25","type":"Limit","timeInForce":"DAY","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.1993,"stopPrice":0,"minQty":0,"maxShow":100,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4860875001","tradeDate":"2022-10-11","userFullName":"user1@pfgOrg","action":"place","status":"NEW"},{"coId":"Stop11","type":"Stop","timeInForce":"GTC","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.19353,"stopPrice":1.19353,"minQty":0,"maxShow":100,"execFlags":["BidTrigger"],"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4820275012","tradeDate":"2022-10-11","userFullName":"user1@pfgOrg","action":"place","status":"ACTIVE"}],"key":"allActiveOrders-OmitCoId","summary":"coId omitted, all active orders","id":"paths/~1v2~1orders/get/responses/200/content/application~1json/examples/allActiveOrders-OmitCoId"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit":{"value":{"coId":"8932452311944","type":"Limit","timeInForce":"IOC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","price":1.0971678,"orderId":"4820276016","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseLimit","summary":"Placed order response (limit IOC)","description":"Successful limit order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimit"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled":{"value":{"coId":"8932452311944","type":"Limit","timeInForce":"IOC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"BrokerOrg1","account":"BrokerOrg1LE5","maxShow":1000000,"averagePrice":1.0971669,"cumQty":1000000,"orderId":"4820276016","userFullName":"User1@pfOrg","action":"place","status":"FILLED"},"key":"responseLimitFilled","summary":"Filled order response (limit IOC)","description":"Filled limit order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseLimitFilled"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop":{"value":{"coId":"Stop11","type":"Stop","rateId":"M-FP.G479697b2e_99cf1__17fc06ddda2_55ba","timeInForce":"GTC","side":"Sell","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"pfOrg","account":"pfOrgLE","price":1.19353,"stopPrice":1.19353,"execFlags":["BidTrigger"],"clientOrderTime":"2020-10-07 14:02:32,877 +0000","orderId":"4820275012","userFullName":"User1@MAIN.pfOrg","action":"place","status":"RECEIVED"},"key":"responseStop","summary":"Placed order response (stop)","description":"Successful stop order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseStop"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket":{"value":{"coId":"Order20","type":"Market","timeInForce":"GTT","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":9000000,"org":"BrokerOrg1","price":1.1864,"expiryTime":35,"orderId":"4820275013","userFullName":"User1@pfOrg","action":"place","status":"RECEIVED"},"key":"responseMarket","summary":"Placed order response (market)","description":"Successful market order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseMarket"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled":{"value":{"coId":"1685730661","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"USD","symbol":"USD/INR","size":1000000,"priceType":"NDF","org":"CustomerOrg","account":"CustomerOrgle1","maxShow":1000000,"averagePrice":83.839,"cumQty":1000000,"orderId":"4892228085","valueDate":"2023-06-15","tradeDate":"2023-06-02","userFullName":"userName@CustomerOrg","action":"place","status":"FILLED"},"key":"responseAtBestFilled","summary":"Filled order query response (at best)","description":"Filled at-best order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestFilled"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired":{"value":{"coId":"16857304844","type":"AtBest","timeInForce":"FOK","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"CustomerOrg","account":"CustomerOrgle1","averagePrice":0,"cumQty":0,"orderId":"4892226279","valueDate":"2023-04-20","tradeDate":"2023-04-19","userFullName":"otherUserName@CustomerOrg","action":"place","status":"EXPIRED"},"key":"responseAtBestExpired","summary":"Expired order query response (at best)","description":"Expired at-best order","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseAtBestExpired"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending":{"value":{"coId":"order9","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"SanityOrg","account":"SanityOrgLE","stopPrice":0,"minQty":0,"maxShow":1000000,"actionOnExpiry":"NoAction","averagePrice":0,"cumQty":0,"orderId":"4795143575","action":"place","status":"PENDING_CANCEL"},"key":"responseCancelPending","summary":"Canceled order pending","description":"Order with request to cancel received.","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCancelPending"},"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled":{"value":{"coId":"order9","type":"Limit","timeInForce":"GTC","side":"Buy","currency":"EUR","symbol":"EUR/USD","size":1000000,"org":"SanityOrg","price":0.3,"averagePrice":0,"cumQty":0,"orderId":"4795143575","executionType":"Pending Cancel","leavesQty":1000000,"action":"place","status":"CANCELED"},"key":"responseCanceled","summary":"Canceled order","description":"Canceled order no longer active.","id":"paths/~1v2~1orders~1{id}/get/responses/200/content/application~1json/examples/responseCanceled"},"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot":{"value":{"type":"Spot","channel":"1","clientRequestId":"req Spot 644","counterparty":"BrokerOrg","counterpartyAccount":"BrokerOrgLE","counterpartyTrader":"BrokerOrgUser","coverRate":1.1234,"creditMode":2,"creditValuationAdjustment":1.44,"customerAccount":"CustOrg1le1","customerOrg":"CustOrg1","trader":"CustOrg1User","dealtAmount":2000000,"dealtIns":"USD","note":"Notes on trade","rate":1.09706,"rateId":"2022-05-12-GBPUSD-SP-435cd558","referenceId":"ref A4f2","side":"SELL","spotRate":1.09696,"stp":true,"symbol":"GBP/USD","tradeDate":"2022-05-12","valueDate":"2022-05-17"},"key":"bookSpot","summary":"Book spot","id":"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSpot"},"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright":{"value":{"type":"Outright","channel":"0","clientRequestId":"req OR 23","counterparty":"BrokerOrg","counterpartyAccount":"BrokerOrgLE","counterpartyTrader":"BrokerOrgUser","coverRate":1.1234,"creditMode":2,"creditValuationAdjustment":1.44,"customerAccount":"CustOrg1le1","customerOrg":"CustOrg1","trader":"CustOrg1User3","dealtAmount":2000000,"dealtIns":"USD","forwardPoints":0.00002,"note":"Notes on trade","rate":1.09706,"referenceId":"ref A4f6","side":"SELL","spotRate":1.09696,"stp":true,"symbol":"GBP/USD","tradeDate":"2022-05-12","valueDate":"2022-05-19"},"key":"bookOutright","summary":"Book outright","id":"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookOutright"},"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap":{"value":{"type":"Swap","channel":"0","clientRequestId":"req swap 1","counterparty":"BrokerOrg","counterpartyAccount":"BrokerOrgLE","counterpartyTrader":"BrokerOrgUser","coverRate":1.1234,"creditMode":0,"creditValuationAdjustment":1.44,"customerAccount":"CustOrg1le1","customerOrg":"CustOrg1","trader":"CustOrg1User3","dealtAmount":2000000,"dealtIns":"USD","farCoverRate":3.231,"farDealtAmount":1000000,"farForwardPoints":-0.0002,"farRate":1.09676,"farTenor":"2W","forwardPoints":0.0001,"note":"Notes on trade","rate":1.09706,"referenceId":"refID A42ef","side":"SELL","spotRate":1.09696,"stp":true,"symbol":"GBP/USD","tradeDate":"2022-05-10","valueDate":"2022-05-13","farValueDate":"2022-05-20"},"key":"bookSwap","summary":"Book swap","id":"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookSwap"},"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF":{"value":{"type":"NDF","channel":"0","clientRequestId":"req NDF 5","counterparty":"BrokerOrg","counterpartyAccount":"BrokerOrgLE","coverRate":61.1,"creditValuationAdjustment":1.44,"customerAccount":"CustOrg1le1","customerOrg":"CustOrg1","dealtAmount":100000,"dealtIns":"USD","fixingDate":"2022-05-18","forwardPoints":0.5,"rate":60.5,"rateId":"2022-03-13-EURUSD-NDF-456af902","side":"SELL","spotRate":60,"symbol":"USD/INR","tradeDate":"2022-05-12","valueDate":"2022-05-19"},"key":"bookNDF","summary":"Book NDF","id":"paths/~1v2~1trades/post/requestBody/content/application~1json/examples/bookNDF"},"paths/~1v2~1trades/get/responses/200/content/application~1json/example":{"value":[{"orderId":"4821376492","tradeId":"FXI9222972502","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-08-16","valueDate":"2022-08-18","executionTime":"2022-08-16 08:24:13,239 +0000","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"Cust12LE","customerOrg":"Cust12","trader":"MD","counterparty":"SOR4","cptyLongName":"SOR4","coverTradeIds":[],"cptyTradeId":"Exec-db08b0657900eb","counterpartyAccount":"SOR4LE","counterpartyALEI":"549300YLYOXGEYO4YK89","externalRequestId":"FXI9222877130","benchmarkRate":0,"dealtAmount":2000000,"settledAmount":2372460,"baseAmount":2000000,"termAmount":2372460,"spotRate":1.18623,"rate":1.18623,"fees":0,"initialSettledAmount":2372460,"midMarket":false,"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9222972502","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},{"orderId":"4821376492","tradeId":"FXI9222972501","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-08-16","valueDate":"2022-08-18","executionTime":"2022-08-16 08:24:15,882 +0000","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"Cust12LE","customerOrg":"Cust12","trader":"MD","counterparty":"SOR4","cptyLongName":"SOR4","coverTradeIds":[],"cptyTradeId":"Exec-db08b064811338","counterpartyAccount":"SOR4LE","counterpartyALEI":"549300YLYOXGEYO4YK89","externalRequestId":"FXI9222877130","benchmarkRate":0,"dealtAmount":1000000,"settledAmount":1186240,"baseAmount":1000000,"termAmount":1186240,"spotRate":1.18624,"rate":1.18624,"regulatory":{"orderSubmissionTime":"2022-02-15 09:12:48,926 +0000","tradeExecutionTime":"2022-02-15 09:12:48,968 +0000","mtf":false,"investmentDecisionMaker":"BrokerAQuoter","takerCapacity":"DEAL","executingUser":"BrokerAQuoter","executingOrg":"BrokerA","takerExecutingFirm":"549300YLYO4YK89","sft":false,"npft":false,"preTradeWaiver":"ILQD","postTradeDeferral":"ILQD","takerCountryCode":"GB","customerCountryCode":"GB","customerAccount":"549300YLYO4YK89"},"fees":0,"initialSettledAmount":1186240,"midMarket":false,"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9222972501"}],"id":"paths/~1v2~1trades/get/responses/200/content/application~1json/example"},"paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade":{"value":{"id":"FXI9271593184","spotRate":1.18631,"dealtAmount":21000,"customerAccount":"BrokerCustOrg1le1","forwardPoints":0.0001,"note":"Sales: done after cover"},"key":"amendTrade","summary":"Amend a trade","description":"Amend a trade by customer, rate, and amount.","id":"paths/~1v2~1trades~1amendment/post/requestBody/content/application~1json/examples/amendTrade"},"paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade":{"value":{"id":"FXI9339324216","forwardPoints":0.0002,"valueDate":"2024-10-05","note":"Daily roll"},"key":"rollTrade","summary":"Roll a trade","description":"Roll a trade to a forward date.","id":"paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTrade"},"paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF":{"value":{"id":"FXI9339324216","forwardPoints":0.0002,"valueDate":"2024-10-05","fixingDate":"2024-10-05","note":"Daily roll"},"key":"rollTradeNDF","summary":"Roll an NDF trade","description":"Roll an NDF trade to a forward date.","id":"paths/~1v2~1trades~1roll/post/requestBody/content/application~1json/examples/rollTradeNDF"},"paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade":{"value":{"id":"FXI9270827222","allocations":[{"referenceId":"A123451","allocationAmount":3000000,"side":"BUY","customerAccount":"BrokerCustOrg1le1","note":"Netting out BankA trades"},{"referenceId":"A123452","allocationAmount":9000000,"side":"SELL","customerAccount":"BrokerCustOrg1le2","note":"Netting out BankA trades"}]},"key":"allocateTrade","summary":"Allocate a trade","description":"Divide a trade amongst multiple organizations.","id":"paths/~1v2~1trades~1allocations/post/requestBody/content/application~1json/examples/allocateTrade"},"paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example":{"value":{"originalTradeId":"FXI9270827222","trades":[{"referenceId":"A123451","tradeId":"FXI9270910113"},{"referenceId":"A123452","tradeId":"FXI9270910116"}]},"id":"paths/~1v2~1trades~1allocations/post/responses/200/content/application~1json/example"},"paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId":{"value":{"customerOrg":"BrokerCustOrgDle5","tradeId":"FXI73879011"},"key":"cancelTradeTradeId","summary":"Cancel a trade (tradeId)","description":"Cancel a single trade by trade ID.","id":"paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeTradeId"},"paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId":{"value":{"customerOrg":"BrokerCustOrgDle5","clientRequestId":"A123452_C1_Cover_A123339"},"key":"cancelTradeClientRequestId","summary":"Cancel a trade (clientRequestId)","description":"Cancel one or more trades by your trade request ID.","id":"paths/~1v2~1trades~1cancel/post/requestBody/content/application~1json/examples/cancelTradeClientRequestId"},"paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById":{"value":{"orderId":"4820926010","tradeId":"FXI9222877182","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-03-01","valueDate":"2022-03-03","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"pfOrg","customerOrg":"pfOrg","trader":"DealerUser","counterparty":"CptyA","cptyLongName":"Counterparty A","coverTradeIds":["FXI9222877182C"],"cptyTradeId":"FXI9222877182C","counterpartyAccount":"CptyA_LE","channel":"API/REST/ESP","externalRequestId":"Spot3442","benchmarkRate":0,"dealtAmount":1000000,"settledAmount":1186310,"baseAmount":1000000,"termAmount":1186310,"spotRate":1.18631,"rate":1.18631,"fees":0,"initialSettledAmount":1186310,"midMarket":false,"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9222877182"},"key":"tradeById","summary":"Trade by trade ID","description":"Done trade returned from query by trade ID","id":"paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeById"},"paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams":{"value":{"orderId":"FXI4406311106","tradeId":"FXI4406311106","tradeType":"Spot","tenor":"Spot","tradeDate":"2025-07-01","valueDate":"2025-07-03","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","rateid":"G-479697b30-197c51c2818-WFNAD-d8846","customerAccount":"BrokerCustomerOrg_LE","customerOrg":"BrokerCustomerOrg","trader":"traderUser","counterParty":"BrokerOrg","cptyLongName":"Broker Dealer Org","coverTradeIds":[],"cptyTradeId":"","counterPartyAccount":"BrokerOrg","counterpartyBLEI":"BrokerOrgLEI1234342343242","externalRequestId":"req26","channel":"API/REST/RFS","executionTime":"2025-07-01 08:33:20,136 +0000","dealtAmount":1000000,"settledAmount":1275420,"baseAmount":1000000,"termAmount":1275420,"spotRate":1.27542,"rate":1.27542,"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"key":"tradeByIdCustomParams","summary":"Trade by trade ID w/ custom params","description":"Done trade with custom parameters returned from query by trade ID","id":"paths/~1v2~1trades~1{id}/get/responses/200/content/application~1json/examples/tradeByIdCustomParams"},"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS":{"value":{"clOrderId":"view1MultiLP5","symbol":"EUR/USD","amount":1000000,"dealtCurrency":"EUR","expiry":140,"nearValueDate":"1W","farDealtAmount":1000000,"farValueDate":"2W","side":"TWO_WAY","priceType":"FwdFwd","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"]},"key":"requestRFS","summary":"Request RFS (forward-forward)","id":"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFS"},"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams":{"value":{"clOrderId":"view1MultiLP5","symbol":"EUR/USD","amount":1000000,"dealtCurrency":"EUR","expiry":140,"nearValueDate":"1W","farDealtAmount":1000000,"farValueDate":"2W","side":"TWO_WAY","priceType":"FwdFwd","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"],"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"key":"requestRFSCustomParams","summary":"Request RFS (forward-forward, custom params)","id":"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFSCustomParams"},"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ":{"value":{"clOrderId":"quote-EURUSD-578-5min","symbol":"EUR/USD","amount":500000,"dealtCurrency":"USD","expiry":600,"rfq":true,"nearValueDate":"2025-03-25","side":"TWO_WAY","priceType":"Spot","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"]},"key":"requestRFQ","summary":"Request RFQ (spot)","id":"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQ"},"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams":{"value":{"clOrderId":"quote-EURUSD-578-5min","symbol":"EUR/USD","amount":500000,"dealtCurrency":"USD","expiry":600,"rfq":true,"nearValueDate":"2025-03-25","side":"TWO_WAY","priceType":"Spot","customerAccount":"pfOrgLE","customerOrg":"pfOrg","providers":["ProvA","ProvB","ProvC"],"customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}},"key":"requestRFQCustomParams","summary":"Request RFQ (spot, customer params)","id":"paths/~1v2~1rfs/post/requestBody/content/application~1json/examples/requestRFQCustomParams"},"paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b17818a0021e","event":"REQUEST_RECEIVED"},"key":"Success","summary":"REQUEST_RECEIVED","id":"paths/~1v2~1rfs/post/responses/202/content/application~1json/examples/Success"},"paths/~1v2~1rfs/post/responses/400/content/application~1json/example":{"value":{"message":"RequestValidationError.SymbolNotSpecified"},"id":"paths/~1v2~1rfs/post/responses/400/content/application~1json/example"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright":{"value":{"clOrderId":"rjv_566","requestId":"G4796976d5_228bd_19587256c877","transactionId":"FXI9445344076","ttl":7200,"event":"QUOTE","quotes":[{"requestId":"G4796976d5_228bd_19587256c877","priceType":"Outright","effectiveTime":0,"symbol":"USD/CAD","ttl":7200,"dealtCurrency":"USD","status":"A","nearValueDate":"2025-03-19","bids":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"BID","dealtAmount":1000,"settledAmount":1347.77,"provider":"ProvOrgA","rate":1.34777,"spotRate":1.34767,"forwardPoint":0.0001,"midRate":0}],"offers":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"OFFER","dealtAmount":1000,"settledAmount":1349.87,"provider":"ProvOrgA","rate":1.34987,"spotRate":1.34967,"forwardPoint":0.0002,"midRate":0}]}]},"key":"QuotedOutright","summary":"QUOTE (outright)","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedOutright"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":40,"event":"QUOTE","quotes":[{"requestId":"G4796976d517b17818a0021e","priceType":"FwdFwd","effectiveTime":0,"symbol":"EUR/USD","ttl":111,"dealtCurrency":"EUR","status":"A","nearValueDate":"2023-04-07","farValueDate":"2023-04-19","bids":[{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1199.92,"provider":"ProvB","rate":1.19992,"spotRate":1.19972,"forwardPoint":0.0002,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1469.34,"provider":"Prov1A","rate":1.46934,"spotRate":1.46924,"forwardPoint":0.0001,"midRate":1.47014},{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1187.43,"provider":"ProvB","rate":1.18743,"spotRate":1.18763,"forwardPoint":-0.0002,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1470.54,"provider":"SGX","rate":1.47054,"spotRate":1.47074,"forwardPoint":-0.0002,"midRate":1.46984}],"offers":[{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1199.62,"provider":"ProvB","rate":1.19962,"spotRate":1.19972,"forwardPoint":-0.0001,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1469.14,"provider":"Prov1A","rate":1.46914,"spotRate":1.46924,"forwardPoint":-0.0001,"midRate":1.46984},{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1187.73,"provider":"ProvB","rate":1.18773,"spotRate":1.18763,"forwardPoint":0.0001,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1470.94,"provider":"Prov1A","rate":1.47094,"spotRate":1.47074,"forwardPoint":0.0002,"midRate":1.47014}]}]},"key":"QuotedFwdFwd","summary":"QUOTE (forward/forward swap)","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/QuotedFwdFwd"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"TRADE_VERIFIED","trades":[{"orderId":"FXI9219477338","tradeId":"FXI9219477338","tradeType":"FwdFwd","tradeDate":"2022-02-04","valueDate":"2022-02-07","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"pfOrg","customerOrg":"pfOrg","trader":"user1","counterparty":"BRK1","cptyLongName":"BRK1","cptyTradeId":"ASX100123-v","counterPartyAccount":"BRK1","farValueDate":"2022-02-16","farSide":"Buy","externalRequestId":"rfs11","requestId":"G4796976d517ec6108f3ef1f","benchmarkRate":0,"farLegISIN":"EZ8SM8VRH1L0","nearLegISIN":"EZW51H6Z01T4","dealtAmount":1000000,"settledAmount":1186740,"baseAmount":1000000,"termAmount":1186740,"spotRate":1.18644,"rate":1.186443,"forwardPoints":0.000003,"swapPoints":0.000001,"farRate":1.186444,"farDealtAmount":2000000,"farSettledAmount":2373790,"farBaseAmount":2000000,"farTermAmount":2373790,"farForwardPoints":0.000004,"upi":"EUR_USD_SWAP","uti":"MCQRZU5ST1INP9219477338","midMarket":false}]},"key":"Verified","summary":"TRADE_VERIFIED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Verified"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_RECEIVED"},"key":"Initial","summary":"REQUEST_RECEIVED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Initial"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted":{"value":{"clOrderId":"view1MultiLP8","requestId":"G4796976d512eg341786e1f234","transactionId":"FXI9218763489","ttl":112,"event":"REQUEST_ACCEPTED"},"key":"Accepted","summary":"REQUEST_ACCEPTED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Accepted"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined":{"value":{"clOrderId":"view1MultiLP7","requestId":"G4796976d517b1786esdf3454","event":"REQUEST_DECLINED","reason":"User does not have permissions."},"key":"Declined","summary":"REQUEST_DECLINED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Declined"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected":{"value":{"clOrderId":"view1MultiLP6","requestId":"G4796976d517b1786e1f3453","transactionId":"FXI9218675295","ttl":111,"event":"TRADE_REJECTED"},"key":"Rejected","summary":"TRADE_REJECTED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Rejected"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_WITHDRAWN"},"key":"Cancelled","summary":"REQUEST_WITHDRAWN","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Cancelled"},"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1sstb2h5ye1fa","transactionId":"FXI9218602325","ttl":40,"event":"REQUEST_EXPIRED"},"key":"Expired","summary":"REQUEST_EXPIRED","id":"paths/~1v2~1rfs/get/responses/200/content/application~1json/examples/Expired"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright":{"value":{"clOrderId":"rjv_566","requestId":"G4796976d5_228bd_19587256c877","transactionId":"FXI9445344076","ttl":7200,"event":"QUOTE","quotes":[{"requestId":"G4796976d5_228bd_19587256c877","priceType":"Outright","effectiveTime":0,"symbol":"USD/CAD","ttl":7200,"dealtCurrency":"USD","status":"A","nearValueDate":"2025-03-19","bids":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"BID","dealtAmount":1000,"settledAmount":1347.77,"provider":"ProvOrgA","rate":1.34777,"spotRate":1.34767,"forwardPoint":0.0001,"midRate":0}],"offers":[{"legType":0,"quoteId":"G-4796976d3-19587259266-SUCD-74d3cb-PaymentsOrg-ProvOrgA-1741729141431","type":"OFFER","dealtAmount":1000,"settledAmount":1349.87,"provider":"ProvOrgA","rate":1.34987,"spotRate":1.34967,"forwardPoint":0.0002,"midRate":0}]}]},"key":"QuotedOutright","summary":"QUOTE (outright)","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedOutright"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":40,"event":"QUOTE","quotes":[{"requestId":"G4796976d517b17818a0021e","priceType":"FwdFwd","effectiveTime":0,"symbol":"EUR/USD","ttl":111,"dealtCurrency":"EUR","status":"A","nearValueDate":"2023-04-07","farValueDate":"2023-04-19","bids":[{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1199.92,"provider":"ProvB","rate":1.19992,"spotRate":1.19972,"forwardPoint":0.0002,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1469.34,"provider":"Prov1A","rate":1.46934,"spotRate":1.46924,"forwardPoint":0.0001,"midRate":1.47014},{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"BID","dealtAmount":1000,"settledAmount":1187.43,"provider":"ProvB","rate":1.18743,"spotRate":1.18763,"forwardPoint":-0.0002,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"BID","dealtAmount":1000,"settledAmount":1470.54,"provider":"SGX","rate":1.47054,"spotRate":1.47074,"forwardPoint":-0.0002,"midRate":1.46984}],"offers":[{"legType":1,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1199.62,"provider":"ProvB","rate":1.19962,"spotRate":1.19972,"forwardPoint":-0.0001,"midRate":1.193525},{"legType":1,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1469.14,"provider":"Prov1A","rate":1.46914,"spotRate":1.46924,"forwardPoint":-0.0001,"midRate":1.46984},{"legType":0,"quoteId":"G-479697b31-18746c2f563-ProvBlp-28d-fOrg-ProvB-1680519394653","type":"OFFER","dealtAmount":1000,"settledAmount":1187.73,"provider":"ProvB","rate":1.18773,"spotRate":1.18763,"forwardPoint":0.0001,"midRate":1.193825},{"legType":0,"quoteId":"G-479697b31-18746c30076-Prov1Aac-28f-pfOrg-Prov1A-1680519397488","type":"OFFER","dealtAmount":1000,"settledAmount":1470.94,"provider":"Prov1A","rate":1.47094,"spotRate":1.47074,"forwardPoint":0.0002,"midRate":1.47014}]}]},"key":"QuotedFwdFwd","summary":"QUOTE (forward/forward swap)","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/QuotedFwdFwd"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_RECEIVED"},"key":"Initial","summary":"REQUEST_RECEIVED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Initial"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted":{"value":{"clOrderId":"view1MultiLP8","requestId":"G4796976d512eg341786e1f234","transactionId":"FXI9218763489","ttl":112,"event":"REQUEST_ACCEPTED"},"key":"Accepted","summary":"REQUEST_ACCEPTED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Accepted"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1sstb2h5ye111","transactionId":"FXI9218602325","ttl":40,"event":"TRADE_PENDING"},"key":"Pending","summary":"TRADE_PENDING","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Pending"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"TRADE_VERIFIED","trades":[{"orderId":"FXI9219477338","tradeId":"FXI9219477338","tradeType":"FwdFwd","tradeDate":"2022-02-04","valueDate":"2022-02-07","maker":false,"orderSide":"Sell","status":"Verified","symbol":"EUR/USD","dealtIns":"EUR","customerAccount":"pfOrg","customerOrg":"pfOrg","trader":"user1","counterparty":"BRK1","cptyLongName":"BRK1","cptyTradeId":"ASX100123-v","counterPartyAccount":"BRK1","farValueDate":"2022-02-16","farSide":"Buy","externalRequestId":"rfs11","requestId":"G4796976d517ec6108f3ef1f","benchmarkRate":0,"farLegISIN":"EZ8SM8VRH1L0","nearLegISIN":"EZW51H6Z01T4","dealtAmount":1000000,"settledAmount":1186740,"baseAmount":1000000,"termAmount":1186740,"spotRate":1.18644,"rate":1.186443,"forwardPoints":0.000003,"swapPoints":0.000001,"farRate":1.186444,"farDealtAmount":2000000,"farSettledAmount":2373790,"farBaseAmount":2000000,"farTermAmount":2373790,"farForwardPoints":0.000004,"upi":"EUR_USD_SWAP","uti":"MCQRZU5ST1INP9219477338","midMarket":false}]},"key":"Verified","summary":"TRADE_VERIFIED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Verified"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined":{"value":{"clOrderId":"view1MultiLP7","requestId":"G4796976d517b1786esdf3454","event":"REQUEST_DECLINED","reason":"User does not have permissions."},"key":"Declined","summary":"REQUEST_DECLINED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Declined"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected":{"value":{"clOrderId":"view1MultiLP6","requestId":"G4796976d517b1786e1f3453","transactionId":"FXI9218675295","ttl":111,"event":"TRADE_REJECTED"},"key":"Rejected","summary":"TRADE_REJECTED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Rejected"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1786e1fa242","transactionId":"FXI9218602325","ttl":111,"event":"REQUEST_WITHDRAWN"},"key":"Cancelled","summary":"REQUEST_WITHDRAWN","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Cancelled"},"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired":{"value":{"clOrderId":"view1MultiLP5","requestId":"G4796976d517b1sstb2h5ye1fa","transactionId":"FXI9218602325","ttl":40,"event":"REQUEST_EXPIRED"},"key":"Expired","summary":"REQUEST_EXPIRED","id":"paths/~1v2~1rfs~1{requestId}/get/responses/200/content/application~1json/examples/Expired"},"paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS":{"value":{"quoteId":"G-4796976cf-17b1781b062","side":"BUY","symbol":"GBP/USD","dealtCurrency":"USD","clOrderId":"view1MultiLP5"},"key":"AcceptRFS","summary":"RFS accept","id":"paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFS"},"paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ":{"value":{"quoteId":"G-4796976cf-17b1781ef16","side":"SELL","symbol":"EUR/USD","dealtCurrency":"USD","transactionId":"FXI28550024","clOrderId":"Sell-EuroQuote-5min","rfq":true},"key":"AcceptRFQ","summary":"RFQ accept","id":"paths/~1v2~1rfs~1{requestId}/post/requestBody/content/application~1json/examples/AcceptRFQ"},"paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position":{"value":[{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-11","level":"ORG","levelValue":"pfOrg","netOpenBase":200000,"netOpenterm":237278,"rate":1.18639,"realizedPnL":0,"unrealizedPnL":-22,"pnlCurrency":"USD"},{"side":"Short","symbol":"EUR/USD","valueDate":"2022-03-18","level":"ORG","levelValue":"pfOrg","netOpenBase":5000000,"netOpenterm":5933600,"rate":1.18672,"realizedPnL":0,"unrealizedPnL":1600,"pnlCurrency":"USD"},{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-25","level":"ORG","levelValue":"pfOrg","netOpenBase":10000000,"netOpenterm":11865200,"rate":1.18652,"realizedPnL":0,"unrealizedPnL":-2400,"pnlCurrency":"USD"},{"symbol":"EUR/USD","valueDate":"2022-03-23","level":"ORG","levelValue":"pfOrg","netOpenBase":0,"netOpenterm":0,"realizedPnL":-280,"unrealizedPnL":0,"pnlCurrency":"USD"}],"key":"position","summary":"List of positions","id":"paths/~1v2~1positions/get/responses/200/content/application~1json/examples/position"},"paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position":{"value":[{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-11","level":"ORG","levelValue":"pfOrg","netOpenBase":200000,"netOpenterm":237278,"rate":1.18639,"realizedPnL":0,"unrealizedPnL":-22,"pnlCurrency":"USD"},{"side":"Short","symbol":"EUR/USD","valueDate":"2022-03-18","level":"ORG","levelValue":"pfOrg","netOpenBase":5000000,"netOpenterm":5933600,"rate":1.18672,"realizedPnL":0,"unrealizedPnL":1600,"pnlCurrency":"USD"},{"side":"Long","symbol":"EUR/USD","valueDate":"2022-03-25","level":"ORG","levelValue":"pfOrg","netOpenBase":10000000,"netOpenterm":11865200,"rate":1.18652,"realizedPnL":0,"unrealizedPnL":-2400,"pnlCurrency":"USD"},{"symbol":"EUR/USD","valueDate":"2022-03-23","level":"ORG","levelValue":"pfOrg","netOpenBase":0,"netOpenterm":0,"realizedPnL":-280,"unrealizedPnL":0,"pnlCurrency":"USD"}],"key":"position","summary":"List of positions","id":"paths/~1v2~1positions~1{valueDate}/get/responses/200/content/application~1json/examples/position"},"paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance":{"value":{"custodyOrg":"custodyOrgId","customerOrg":"customerOrgId","balances":[{"currency":"BTC","balance":10.12922,"holds":1.0092,"available":9.12002}]},"key":"oneBalance","summary":"Response with one balance","id":"paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/oneBalance"},"paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance":{"value":{"custodyOrg":"custodyOrgId","customerOrg":"customerOrgId","balances":[{"currency":"BTC","balance":10.12922,"holds":1.0092,"available":9.12002},{"currency":"ETH","balance":253.40811,"holds":10,"available":243.40811},{"currency":"USD","balance":92984.58,"holds":200,"available":92784.58}]},"key":"multiBalance","summary":"Response with multiple balances","id":"paths/~1custody~1v2~1account~1balances/get/responses/200/content/application~1json/examples/multiBalance"},"paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances":{"value":[{"custodyOrg":"BrokerName","customerOrg":"LP1","balances":[{"currency":"XRP","balance":10.9802,"holds":0,"available":10.9802,"tradingBalance":10.9802},{"currency":"ETH","balance":0.00000998,"holds":0,"available":0.00000998,"tradingBalance":0.00000998},{"currency":"TRY","balance":873.325279,"holds":0,"available":873.32527908,"tradingBalance":873.32527908},{"currency":"USDT","balance":251.32195575,"holds":0,"available":251.32195575,"tradingBalance":251.32195575},{"currency":"AVAX","balance":0.20414155,"holds":0,"available":0.20414155,"tradingBalance":0.20414155},{"currency":"BTC","balance":0.00020663,"holds":0,"available":0.00020663,"tradingBalance":0.00020663}]}],"key":"BrokerBalances","summary":"Response with multiple balances from broker organizations","id":"paths/~1custody~1v2~1broker~1account~1balances/get/responses/200/content/application~1json/examples/BrokerBalances"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit":{"value":[{"orderId":"4820276016","tradeId":"FXI9369258100","tradeType":"Spot","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"BrokerOrg1","counterpartyLongName":"The Broker Org","counterpartyAccount":"BrokerOrg1LE5","coId":"8932452311944","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097166.9,"baseAmount":1000000,"termAmount":1097166.9,"spotRate":1.0971669,"rate":1.0971669,"event":"NEW","channelCategory":"API","upi":"EUR_USD_SPOT","uti":"1234567890AQUSUUINP9349138130"}],"key":"SpotLimit","summary":"Spot from limit order, taker download","description":"STP download of trade to fill limit order request","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimit"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams":{"value":[{"orderId":"4820276016","tradeId":"FXI9369258100","tradeType":"Spot","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"BrokerOrg1","counterpartyLongName":"The Broker Org","counterpartyAccount":"BrokerOrg1LE5","coId":"8932452311944","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097166.9,"baseAmount":1000000,"termAmount":1097166.9,"spotRate":1.0971669,"rate":1.0971669,"event":"NEW","channelCategory":"API","upi":"EUR_USD_SPOT","uti":"1234567890AQUSUUINP9349138130","customParameters":{"keyName":"Number of params, names, and values defined by your org (see description)","SUBPURPOSE":"D-Direct Investment","PURPOSE":"DIRECTINVEST","ACCD":"D-Direct Investment"}}],"key":"SpotLimitCustomParams","summary":"Spot from limit order, taker download, custom parameters","description":"STP download of trade to fill limit order request with custom parameters","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/SpotLimitCustomParams"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot":{"value":[{"orderId":"4829069175","tradeId":"FXI9232048063","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650554289719","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:18:09,875 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"NEW","upi":"EUR_USD_SPOT","usi":"MCQRZU5ST1INP9232048063"},{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32,413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"RESEND","upi":"EUR_USD_SPOT","usi":"MCQRZU5ST1INP9232048066"}],"key":"Spot","summary":"Spot, taker download","description":"STP download received by TAKER","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Spot"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot":{"value":[{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"NEW","coverRate":1.09691,"coverSpotRate":1.09691,"spreads":{"ppSpotSpread":0.00055,"ppCustSpread":0.00055},"upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048066"},{"orderId":"4829108080","tradeId":"FXI9232111143","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA_LE1","customerOrg":"BrokerA","user":"jk1@BrokerA","counterparty":"CustB","counterpartyLongName":"Customer B","counterpartyAccount":"CustB-le","counterpartyLEI":"CustB-LEI","coId":"FXI9232048066","channel":"BA/ESP","executionTime":"2022-04-21 15:33:32417 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"NEW","coveredTradeId":"FXI9232048066","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232111143"}],"key":"CustomerCoverSpot","summary":"Customer and cover trade, spot, maker download","description":"STP download received by MAKER","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverSpot"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright":{"value":[{"orderId":"4892228085","tradeId":"FXI9349138130","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"CptyOrg","counterpartyLongName":"CptyOrg","counterpartyAccount":"CptyOrgLE1","coId":"1685730661","channel":"API/REST/ESP","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","channelCategory":"API","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349138130"}],"key":"CustomerOutright","summary":"Customer trade, outright, taker download","description":"STP download received by TAKER","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerOutright"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright":{"value":[{"orderId":"4892228085","tradeId":"FXI9349138130","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":true,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"CustomerOrgle1","customerOrg":"CustomerOrg","user":"userName@CustomerOrg","counterparty":"CptyOrg","counterpartyLongName":"CptyOrg","counterpartyAccount":"le1codeAtCptyOrg","coId":"1685730661","channel":"API/REST/RFS","executionTime":"2023-06-02 18:31:01,301 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","coverRate":1.0966372,"coverSpotRate":1.09643,"coverForwardPoints":0.0002072,"spreads":{"pmPreSpotSpread":0.0005,"pmSpotSpread":0.0005},"coverRiskManagementType":"COVER","channelCategory":"API","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349138130"},{"orderId":"FXI9349101537","tradeId":"FXI9349101537","tradeType":"Outright","tradeDate":"2023-06-02","valueDate":"2023-06-15","maker":false,"side":"Buy","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"le1codeAtCptyOrg","customerOrg":"CptyOrg","user":"CptyOrgQuoter@CptyOrg","counterparty":"LPOrg","counterpartyLongName":"LP Org Full Name","counterpartyTradeId":"FXI9349101537","counterpartyAccount":"LPOrgCodeAtCptyOrg","counterpartyLEI":"O2RNE8IBXP4R0TD8PU41","coId":"FXI9349138130","channel":"BA/RFS","executionTime":"2023-06-02 18:31:02,336 +0000","dealtAmount":1000000,"settledAmount":1097137.2,"baseAmount":1000000,"termAmount":1097137.2,"spotRate":1.09693,"rate":1.0971372,"forwardPoints":0.0002072,"event":"NEW","channelCategory":"COVER","coveredTradeId":"FXI9349138130","coveredCounterparty":"CustomerOrg","upi":"EUR_USD_OUTRIGHT","uti":"1234567890ABCDEFGHINP9349101537","MT300Field72":"/CMS/Default"}],"key":"CustomerCoverOutright","summary":"Customer and cover trade, outright, maker download","description":"STP download received by MAKER","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/CustomerCoverOutright"},"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend":{"value":[{"orderId":"4829069175","tradeId":"FXI9232048063","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":false,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650554289719","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:18:09875 +0000","dealtAmount":1000000,"settledAmount":1096910,"baseAmount":1000000,"termAmount":1096910,"spotRate":1.09691,"rate":1.09691,"event":"RESEND","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048063"},{"orderId":"4829069176","tradeId":"FXI9232048066","tradeType":"Spot","tenor":"SPOT","tradeDate":"2022-04-21","valueDate":"2022-04-25","maker":true,"side":"Sell","status":"Verified","symbol":"EUR/USD","currency":"EUR","customerAccount":"BrokerA-Customer","customerOrg":"BrokerA-Customer","user":"traderUser@BrokerA-Customer","counterparty":"BrokerA","counterpartyLongName":"BrokerA","counterpartyAccount":"BrokerA_LE1","coId":"1650555212229","channel":"REACT/ESP/FXB/SPOT","executionTime":"2022-04-21 15:33:32413 +0000","dealtAmount":1000000,"settledAmount":1095860,"baseAmount":1000000,"termAmount":1095860,"spotRate":1.09586,"rate":1.09586,"event":"RESEND","upi":"EUR_USD_SPOT","uti":"MCQRZU5ST1INP9232048066"}],"key":"Resend","summary":"Resend, spot, taker download","description":"STP download received by TAKER","id":"paths/~1v2~1trades~1stp~1messages/get/responses/200/content/application~1json/examples/Resend"},"paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency":{"value":{"shortName":"USD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue\"":0.01},"key":"currency","summary":"Quoting details for a currency.","id":"paths/~1v2~1refdata~1currencies~1{instrument}/get/responses/200/content/application~1json/examples/currency"},"paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair":{"value":{"instrument":"EUR/USD","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},"key":"currencyPair","summary":"Quoting details for a currency pair.","id":"paths/~1v2~1refdata~1symbols~1{symbol}/get/responses/200/content/application~1json/examples/currencyPair"},"paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList":{"value":[{"instrument":"EUR/USD","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrumen\"":"EUR/AED","spotPrecision":5,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":7,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrument":"XAU/GBP","spotPrecision":3,"spotPointsPrecision":3,"forwardPointsPrecision":2,"forwardRatePrecision":5,"pipsFactor":100,"instrumentType":"METAL","nonDeliverable":false,"spotValueDate":"2026-03-12"},{"instrument":"EUR/GBP","spotPrecision":6,"spotPointsPrecision":2,"forwardPointsPrecision":0,"forwardRatePrecision":6,"pipsFactor":10000,"instrumentType":"CURRENCY","nonDeliverable":false,"spotValueDate":"2026-03-12"}],"key":"symbolList","summary":"All symbols in the system.","id":"paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/symbolList"},"paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList":{"value":[{"shortName":"USD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue\"":0.01},{"shortName":"US1","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"HKD","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"PHX","instrumentType":"CURRENCY","roundingType":"ROUND_HALF_UP","tickValue":0.01},{"shortName":"IOT","instrumentType":"CRYPTO","roundingType":"ROUND_HALF_UP","tickValue":1},{"shortName":"XAG","instrumentType":"METAL","roundingType":"ROUND_HALF_UP","tickValue":0.001}],"key":"instrumentList","summary":"All instruments supported by the calling organization.","id":"paths/~1v2~1refdata~1currencies/get/responses/200/content/application~1json/examples/instrumentList"}},"securitySchemeStore":{"SSO_TOKEN":{"id":"SSO_TOKEN","type":"apiKey","description":"API key to authorize requests.","in":"header","paramName":"SSO_TOKEN"}},"servers":[{"url":"/_mock/openapi/integral-api-reference/rest","isMockServer":true,"description":"Mock server"}]},"options":{"hideDownloadButtons":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"JavaScript"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/openapi/integral-api-reference/rest","position":"replace","description":"Mock server","strictExamples":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/integral-api-reference/rest.json?download"},{"url":"/_bundle/openapi/integral-api-reference/rest.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"REST API","description":"\nWelcome to the Integral REST API reference. \n\nOur REST API is for less latency-sensitive participants and has resource-oriented URLs, accepts JSON-encoded requests, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\nContact Integral’s account management team to get connection details and credentials for access.\n\n# Authentication options\n\nYou can choose between two authentication methods:\n\n- [Token-based authentication](#section/Authentication-options%2FToken-based-authentication)\n- [HMAC authentication](#section/Authentication-options%2FHMAC-authentication)\n\n## Token-based authentication\n\nAn ID and password will be issued to you to generate and refresh/renew an access token. All REST API calls should pass this token to access authenticated services. \n\n### Get token\n\nUsers should use [/v2/sso/login](#operation/login) to get an access token. The access token is in `SSO_TOKEN` of the response header. Your token is valid for a limited time.\n\n### Pass token\n\nThe token should be sent in `SSO_TOKEN` of request headers.\n\n### Renew token\n\nTo keep your session alive, you can renew your token with [/sso/tokens/renew](#operation/renewToken). If your token is expired, you are issued a new token.\n\n## HMAC authentication\n\nIn this authentication method, you must sign each API request with a 'secret'. The 'secret' and 'userId' are issued to you during set up.\n\nAll REST requests must contain following header information:\n\n{% table %}\n  - Header attribute {% width=\"10%\" %}\n  - Description\n  ---\n  - Authorization\n  - The base64-encoded signature.\n  ---\n  - Date\n  - A date and time as [standard UTC string](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date).\n  ---\n  - Digest\n  - `SHA-256=base64(sha256(<body>))` If there is no request body, `Digest` should be set to the digest of a body of 0 length.\n  ---\n  - type\n  - Set to `hmac`.\n{% /table %}\n\nYou must send an authorization header with the following parameterization:\n\n```\ncredentials := \"hmac\" params\nparams := userId \",\" algorithm \", \" headers \", \" signature\nuserId := \"username\" \"=\" plain-string\nalgorithm := \"algorithm\" \"=\" DQUOTE (hmac-sha256) DQUOTE\nheaders := \"headers\" \"=\" plain-string\nsignature := \"signature\" \"=\" plain-string\nplain-string   = DQUOTE *( %x20-21 / %x23-5B / %x5D-7E ) DQUOTE\n```\n\n### Signature parameters\n\n{% table %}\n  - Parameter {% width=\"15%\" %}\n  - Description\n  ---\n  - `username`\n  - The ID of the credential.\n  ---\n  - `algorithm`\n  - Digital signature algorithm used to create the signature. You should use `hmac-sha256`.\n  ---\n  - `headers`\n  - List of HTTP header names, separated by a single space character, used to sign the request.\n  ---\n  - `signature`\n  - Base64 encoded digital signature generated by the client.\n{% /table %}\n\n### Sample authorization header\n\n```\nAuthorization: hmac userId=\"user2@XCN1139\",\n  algorithm=\"hmac-sha256\",\n  headers=\"date content-type content-length\",\n  signature=\"XWL1oxJsbC4z3UvO6ZfvgjMvfj249WXSb7Gl/+t/Ql0=\"\n```\n\n### Signature string construction\n\nTo generate the string that is signed with a secret, the client must take the values of each HTTP header specified by headers in the order they appear.\n\n1. If the header name is not `request-line`, then append the lowercase header name followed with an ASCII colon `:` and an ASCII space `' '`.\n2. If the header name is `request-line`, then append the HTTP request line (in ASCII format), otherwise append the header value.\n3. If the value is not the last value, then append an ASCII newline `\\n`. The string must not include a trailing ASCII newline.\n\n# API tracing\n\nYou can set `X-Request-ID` on the request's HTTP header to trace each API call. The system echos back this header in the response.\n\n# Status and error codes\n\nAll Integral REST APIs use the following general status codes. See endpoints for specific codes.\n\n{% table %}\n  - HTTP code {% width=\"15%\" %}\n  - HTTP status\n  - Meaning\n  ---\n  - 200\n  - OK\n  - Successful submission.\n  ---\n  - 202\n  - ACCEPTED\n  - Request accepted by the system. You are expected to make another API call. Refer to individual API sections and endpoints for subsequent action.\n  ---\n  - 400\n  - BAD REQUEST\n  - There is an issue with request parameters. May have a message body that indicates the error. Refer to individual API sections and endpoints for specific errors.\n  ---\n  - 401\n  - UNAUTHORIZED\n  - Your IntegralAPI user is not authorized. May have a message body that indicates the error.\n  ---\n  - 404\n  - NOT FOUND\n  - The endpoint could not be found. Either your valid request did not return any results or your request was malformed. May have a message body that indicates the error. Refer to individual API endpoints to confirm that the endpoint URL and parameters are correct.\n  ---\n  - 500\n  - INTERNAL SERVER ERROR\n  - Stop trading immediately and contact Integral Business Support with a complete error message and full details of the HTTP request and response. May have a message body that indicates the error.\n{% /table %}\n\n4xx and 5xx status codes may return a JSON response body with the `message` parameter.\n\n# Reason codes\n\nYou determine the status of any call with a combination of:\n\n- Status code from the messaging technology (for example, REST/HTTP codes `200` and `404`).\n- The reason code for the server. **Not all responses include a reason code.**\n\nUse the following codes to interpret and act on status responses.\n\n{% table %}\n  - Reason code {% width=\"55%\" %}\n  - Description\n  ---\n  - `RequestValidationError.amount`\n  - Order size is invalid.\n  ---\n  - `RequestValidationError.CoIdNotSpecified`\n  - Client order ID not specified.\n  ---\n  - `RequestValidationError.DuplicateOrder`\n  - Order already exists for the given client order ID.\n  ---\n  - `RequestValidationError.TypeNotSpecified`\n  - Order type not specified.\n  ---\n  - `RequestValidationError.TIFNotSpecified`\n  - Time in force not specified.\n  ---\n  - `RequestValidationError.SideNotSpecified`\n  - Order side (buy or sell) not specified.\n  ---\n  - `RequestValidationError.CurrencyNotSpecified`\n  - Order dealt currency not specified.\n  ---\n  - `RequestValidationError.InvalidDealtCcy`\n  - Dealt currency is neither base currency nor term currency.\n  ---\n  - `RequestValidationError.SymbolNotSpecified`\n  - Symbol not specified.\n  ---\n  - `RequestValidationError.InvalidCurrencyPair`\n  - Symbol not valid or not supported by the system.\n  ---\n  - `RequestValidationError.SizeNotSpecified`\n  - Order size not specified.\n  ---\n  - `RequestValidationError.InvalidOrderQty`\n  - Order size not valid.\n  ---\n  - `RequestValidationError.InvalidPrice`\n  - Accepted price invalid. Zero is invalid price.\n  ---\n  - `RequestValidationError.BuySellMismatch`\n  - Buy/Sell side of the accepted price is incorrect.\n  ---\n  - `RequestValidationError.InvalidQuoteID`\n  - The rateId of the previously quoted (PQ) order is invalid.\n  ---\n  - `RequestValidationError.LegalEntitySetIncorrectly`\n  - Account field incorrect.\n  ---\n  - `RequestValidationError.OrderTypeNotSupported`\n  - Order type not supported.\n  ---\n  - `RequestValidationError.PriceMismatch`\n  - Accepted price not the same as previously quoted price.\n  ---\n  - `RequestValidationError.QuoteExpired`\n  - Rate associated with the rateId not found. It has expired. Price is no longer valid.\n  ---\n  - `RequestValidationError.tradingDisabled`\n  - Trading is disabled.\n{% /table %}\n"}},"baseSlug":"/openapi/integral-api-reference/rest","routesMapping":{}}