> For the complete documentation index, see [llms.txt](https://help.enterprise.ledger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.enterprise.ledger.com/api-documentation-v2/reference/tradelink.md).

# Tradelink

## Get Tradelink network instance

> Get the materialized Tradelink Network configuration of workspace

```json
{"openapi":"3.1.0","info":{"title":"revault-api","version":"1.75.0"},"servers":[{"url":"/rest"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"error.UNAUTHORIZED":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Authorization not provided error (401)","description":"The error information"},"error.FORBIDDEN":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Insufficient access error (403)","description":"The error information"},"error.INTERNAL_SERVER_ERROR":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information"}}},"paths":{"/tradelink/network":{"get":{"operationId":"tradelink-getNetwork","summary":"Get Tradelink network instance","description":"Get the materialized Tradelink Network configuration of workspace","tags":["tradelink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"custodian":{"type":"object","properties":{"id":{"type":"string"},"settlement":{"type":"array","items":{"type":"object","properties":{"quorum":{"type":"number","minimum":0,"description":"Number of required approvals for the step"},"userIds":{"type":"array","items":{"type":"string","minLength":1},"description":"User ids in the step"}},"required":["quorum","userIds"],"additionalProperties":false,"description":"Review step with users"}},"withdraw":{"type":"array","items":{"type":"object","properties":{"quorum":{"type":"number","minimum":0,"description":"Number of required approvals for the step"},"userIds":{"type":"array","items":{"type":"string","minLength":1},"description":"User ids in the step"}},"required":["quorum","userIds"],"additionalProperties":false,"description":"Review step with users"}},"arbitration":{"type":"array","items":{"type":"object","properties":{"quorum":{"type":"number","minimum":0,"description":"Number of required approvals for the step"},"userIds":{"type":"array","items":{"type":"string","minLength":1},"description":"User ids in the step"}},"required":["quorum","userIds"],"additionalProperties":false,"description":"Review step with users"}}},"required":["id","settlement","withdraw","arbitration"],"additionalProperties":false},"exchanges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ASSET_MANAGER","EXCHANGE"]},"id":{"type":"string"},"tradelinkId":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"quorum":{"type":"number","minimum":0,"description":"Number of required approvals for the step"},"userIds":{"type":"array","items":{"type":"string","minLength":1},"description":"User ids in the step"}},"required":["quorum","userIds"],"additionalProperties":false,"description":"Review step with users"}},"whitelist":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1,"maxLength":40,"pattern":"^\\w+$","description":"Will be deprecated soon, use network instead. Currency"},"address":{"type":"string","minLength":1}},"required":["name","currency","address"],"additionalProperties":false}}},"required":["type","id","tradelinkId","groups","whitelist"],"additionalProperties":false}},"assetManagers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ASSET_MANAGER","EXCHANGE"]},"id":{"type":"string"},"tradelinkId":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"quorum":{"type":"number","minimum":0,"description":"Number of required approvals for the step"},"userIds":{"type":"array","items":{"type":"string","minLength":1},"description":"User ids in the step"}},"required":["quorum","userIds"],"additionalProperties":false,"description":"Review step with users"}},"whitelist":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1,"maxLength":40,"pattern":"^\\w+$","description":"Will be deprecated soon, use network instead. Currency"},"address":{"type":"string","minLength":1}},"required":["name","currency","address"],"additionalProperties":false}}},"required":["type","id","tradelinkId","groups","whitelist"],"additionalProperties":false}}},"required":["custodian","exchanges","assetManagers"],"additionalProperties":false},{"type":"null"}]}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}}}}
```

## Get Tradelink network blueprint

> Get the Tradelink network blueprint with all available Network configuration options

```json
{"openapi":"3.1.0","info":{"title":"revault-api","version":"1.75.0"},"servers":[{"url":"/rest"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"error.UNAUTHORIZED":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Authorization not provided error (401)","description":"The error information"},"error.FORBIDDEN":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Insufficient access error (403)","description":"The error information"},"error.INTERNAL_SERVER_ERROR":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information"}}},"paths":{"/tradelink/network/blueprint":{"get":{"operationId":"tradelink-getNetworkBlueprint","summary":"Get Tradelink network blueprint","description":"Get the Tradelink network blueprint with all available Network configuration options","tags":["tradelink"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"tradelinkId":{"type":"string"},"workspaceName":{"type":"string","minLength":1,"maxLength":20,"pattern":"^[a-z0-9]+$"},"custodian":{"type":"object","properties":{"tradelinkId":{"type":"string","description":"Unique identifier in Tradelink service"},"name":{"type":"string","description":"Name"},"code":{"type":"string","description":"Code"},"logoUrl":{"type":"string","description":"Logo URL"}},"required":["tradelinkId","name","code","logoUrl"],"additionalProperties":false},"assetManagers":{"type":"array","items":{"type":"object","properties":{"tradelinkId":{"type":"string","description":"Unique identifier in Tradelink service"},"name":{"type":"string","description":"Name"},"code":{"type":"string","description":"Code"},"logoUrl":{"type":"string","description":"Logo URL"}},"required":["tradelinkId","name","code","logoUrl"],"additionalProperties":false}},"exchanges":{"type":"array","items":{"type":"object","properties":{"tradelinkId":{"type":"string","description":"Unique identifier in Tradelink service"},"name":{"type":"string","description":"Name"},"code":{"type":"string","description":"Code"},"logoUrl":{"type":"string","description":"Logo URL"}},"required":["tradelinkId","name","code","logoUrl"],"additionalProperties":false}}},"required":["tradelinkId","workspaceName","custodian","assetManagers","exchanges"],"additionalProperties":false},{"type":"null"}]}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}}}}
```

## Get Tradelink settlements

> Get the Tradelink settlements for the workspace

```json
{"openapi":"3.1.0","info":{"title":"revault-api","version":"1.75.0"},"servers":[{"url":"/rest"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"error.BAD_REQUEST":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Invalid input data error (400)","description":"The error information"},"error.UNAUTHORIZED":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Authorization not provided error (401)","description":"The error information"},"error.FORBIDDEN":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Insufficient access error (403)","description":"The error information"},"error.NOT_FOUND":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Not found error (404)","description":"The error information"},"error.INTERNAL_SERVER_ERROR":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information"}}},"paths":{"/tradelink/settlements":{"get":{"operationId":"tradelink-listSettlements","summary":"Get Tradelink settlements","description":"Get the Tradelink settlements for the workspace","tags":["tradelink"],"parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Which page to fetch","type":"integer","minimum":1,"maximum":9007199254740991}},{"in":"query","name":"pageSize","schema":{"default":30,"description":"Page size to use","type":"integer","minimum":1,"maximum":30}},{"in":"query","name":"pledgeId","schema":{"type":"string"}},{"in":"query","name":"accountId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number","description":"Current page"},"next":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Next page or null if there is none"},"prev":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Previous page or null if there is none"},"pageSize":{"type":"number","description":"Max count of items per page"},"total":{"type":"number","description":"Total count of items"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Settlement ID"},"pledgeId":{"type":"string","description":"Pledge ID associated with the settlement"},"state":{"type":"string","enum":["REGISTERED","PENDING_REPLEDGE_CREATION_APPROVAL","PENDING_REPLEDGE_APPROVAL","PENDING_CREATION_APPROVAL","PENDING_PRE_APPROVAL","PRE_APPROVED","APPROVED","REJECTED","CONFIRMED","FAILED","CANCELED"],"description":"State of the settlement"},"outboundTransactionHash":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Outbound transaction hash of the settlement"},"accountId":{"type":"string","description":"Account ID associated with the settlement"},"exchangeId":{"type":"string","description":"Exchange ID associated with the settlement"}},"required":["id","pledgeId","state","outboundTransactionHash","accountId","exchangeId"],"additionalProperties":false},"description":"Array of results"}},"required":["page","next","prev","pageSize","total","results"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}}}}
```

## Get Tradelink settlement

> Get a Tradelink settlement by its Id

```json
{"openapi":"3.1.0","info":{"title":"revault-api","version":"1.75.0"},"servers":[{"url":"/rest"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"error.BAD_REQUEST":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Invalid input data error (400)","description":"The error information"},"error.UNAUTHORIZED":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Authorization not provided error (401)","description":"The error information"},"error.FORBIDDEN":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Insufficient access error (403)","description":"The error information"},"error.NOT_FOUND":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Not found error (404)","description":"The error information"},"error.INTERNAL_SERVER_ERROR":{"type":"object","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"},"issues":{"description":"An array of issues that were responsible for the error","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information"}}},"paths":{"/tradelink/settlements/{settlementId}":{"get":{"operationId":"tradelink-getSettlement","summary":"Get Tradelink settlement","description":"Get a Tradelink settlement by its Id","tags":["tradelink"],"parameters":[{"in":"path","name":"settlementId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Settlement ID"},"pledgeId":{"type":"string","description":"Pledge ID associated with the settlement"},"state":{"type":"string","enum":["REGISTERED","PENDING_REPLEDGE_CREATION_APPROVAL","PENDING_REPLEDGE_APPROVAL","PENDING_CREATION_APPROVAL","PENDING_PRE_APPROVAL","PRE_APPROVED","APPROVED","REJECTED","CONFIRMED","FAILED","CANCELED"],"description":"State of the settlement"},"outboundTransactionHash":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Outbound transaction hash of the settlement"},"accountId":{"type":"string","description":"Account ID associated with the settlement"},"exchangeId":{"type":"string","description":"Exchange ID associated with the settlement"}},"required":["id","pledgeId","state","outboundTransactionHash","accountId","exchangeId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.enterprise.ledger.com/api-documentation-v2/reference/tradelink.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.