{"openapi":"3.1.0","info":{"title":"Brük Agent API","description":"Verified XRP Ledger answers for AI agents. Every answer carries proof and lists what is not known.","version":"0.12.9"},"paths":{"/v1/pulse":{"get":{"summary":"Ledger pulse — network health now (≈ $0.001)","operationId":"pulse_route_v1_pulse_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/payment-check":{"get":{"summary":"Payment check — did it really settle? (≈ $0.01)","operationId":"payment_check_route_v1_payment_check_get","parameters":[{"name":"tx","in":"query","required":true,"schema":{"type":"string","title":"Tx"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}},{"name":"destination","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount"}},{"name":"currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}},{"name":"destination_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Destination Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/token-check":{"get":{"summary":"Token check — what is this trust-line token or MPT? (≈ $0.01)","description":"One of mpt_issuance_id, or currency plus issuer. Inputs may be query parameters.","operationId":"token_check_route_v1_token_check_get","parameters":[{"name":"mpt_issuance_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mpt Issuance Id"}},{"name":"currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/token-types":{"get":{"summary":"Free guide: token types Brük will and will not check","operationId":"token_types_v1_token_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/issuer-check":{"get":{"summary":"Issuer check — is this token issuer who it claims? (≈ $0.01)","operationId":"issuer_check_route_v1_issuer_check_get","parameters":[{"name":"account","in":"query","required":true,"schema":{"type":"string","title":"Account"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/large-payments":{"get":{"summary":"Large payments — recent big payments, each re-checked (≈ $0.02)","operationId":"large_payments_route_v1_large_payments_get","parameters":[{"name":"minutes","in":"query","required":false,"schema":{"type":"integer","default":60,"title":"Minutes"}},{"name":"min_value","in":"query","required":false,"schema":{"type":"string","default":"50000","title":"Min Value"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/send-check":{"get":{"summary":"Send check — will this payment work? Check before sending (≈ $0.005)","operationId":"send_check_route_v1_send_check_get","parameters":[{"name":"destination","in":"query","required":true,"schema":{"type":"string","title":"Destination"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"XRP","title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}},{"name":"destination_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Destination Tag"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"mpt_issuance_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mpt Issuance Id"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/free/send-check":{"get":{"summary":"Free daily send check — one per visitor per day: verdict, blockers, and cautions","operationId":"free_send_check_v1_free_send_check_get","parameters":[{"name":"destination","in":"query","required":true,"schema":{"type":"string","title":"Destination"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"XRP","title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}},{"name":"destination_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Destination Tag"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"mpt_issuance_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mpt Issuance Id"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/receipt-card":{"get":{"summary":"Receipt card — verified payment receipt image (≈ $0.02)","operationId":"receipt_card_route_v1_receipt_card_get","parameters":[{"name":"tx","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tx"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}},{"name":"destination","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination"}},{"name":"amount","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount"}},{"name":"currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}},{"name":"destination_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Destination Tag"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ledger-moment":{"get":{"summary":"Ledger moment — one ledger drawn as tiles, one per transaction (≈ $0.02)","operationId":"ledger_moment_route_v1_ledger_moment_get","parameters":[{"name":"ledger_index","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ledger Index"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/payment-watch":{"post":{"summary":"Payment watch — webhook when a matching payment is final (≈ $0.05 per watch)","description":"Inputs may be query parameters or a JSON body with the same names.","operationId":"payment_watch_route_v1_payment_watch_post","parameters":[{"name":"address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"}},{"name":"webhook","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook"}},{"name":"destination_tag","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Destination Tag"}},{"name":"min_amount","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Min Amount"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"XRP","title":"Currency"}},{"name":"issuer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuer"}},{"name":"hours","in":"query","required":false,"schema":{"type":"integer","default":24,"title":"Hours"}},{"name":"network","in":"query","required":false,"schema":{"type":"string","default":"mainnet","title":"Network"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/watch/{watch_id}":{"get":{"summary":"Free: status of a payment watch","operationId":"watch_status_v1_watch__watch_id__get","parameters":[{"name":"watch_id","in":"path","required":true,"schema":{"type":"string","title":"Watch Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/learn":{"get":{"summary":"Free: Brük website and film resources for explaining the XRP Ledger","operationId":"learn_v1_learn_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/sample/{name}":{"get":{"summary":"Free sample of any service (cached up to 5 minutes)","operationId":"sample_v1_sample__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/mcp":{"post":{"summary":"Remote MCP server (Streamable HTTP). Paid tools use the x402 MCP transport.","operationId":"mcp_endpoint_mcp_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/.well-known/x402":{"get":{"summary":"X402 Catalog","operationId":"x402_catalog__well_known_x402_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/.well-known/xrp-ledger.toml":{"get":{"summary":"Xrp Ledger Toml","description":"XRPL account verification: this API host names the wallet it is paid into.\nThe wallet's Domain field names brukledger.com, whose own xrp-ledger.toml lists the same wallet.","operationId":"xrp_ledger_toml__well_known_xrp_ledger_toml_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/projects.txt":{"get":{"summary":"Projects Txt","operationId":"projects_txt_projects_txt_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/projects":{"get":{"summary":"Projects Page","operationId":"projects_page_projects_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/robots.txt":{"get":{"summary":"Robots Txt","operationId":"robots_txt_robots_txt_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/llms.txt":{"get":{"summary":"Llms Txt","operationId":"llms_txt_llms_txt_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/":{"get":{"summary":"Root","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}