You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

get-account-objects.json 1.6KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. {
  2. "$schema": "http://json-schema.org/draft-04/schema#",
  3. "title": "getAccountObjectsOptions",
  4. "description": "Request options for getAccountObjects",
  5. "type": "object",
  6. "properties": {
  7. "address": {
  8. "$ref": "address",
  9. "description": "The address of the account to get the account objects of."
  10. },
  11. "options": {
  12. "description": "Options that affect what to return.",
  13. "properties": {
  14. "type": {
  15. "type": "string",
  16. "enum": [
  17. "check",
  18. "escrow",
  19. "offer",
  20. "payment_channel",
  21. "signer_list",
  22. "state"
  23. ],
  24. "description":
  25. "(Optional) Filter results to include only this type of ledger object. The valid types are: `check`, `escrow`, `offer`, `payment_channel`, `signer_list`, and `state` (trust line)."
  26. },
  27. "ledgerHash": {
  28. "type": "string",
  29. "description":
  30. "(Optional) A 20-byte hex string for the ledger version to use."
  31. },
  32. "ledgerIndex": {
  33. "oneOf": [
  34. {
  35. "$ref": "ledgerVersion"
  36. },
  37. {
  38. "type": "string"
  39. }
  40. ],
  41. "description":
  42. "(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically."
  43. },
  44. "limit": {
  45. "type": "integer",
  46. "minimum": 1,
  47. "description":
  48. "(Optional) The maximum number of objects to include in the results."
  49. }
  50. },
  51. "additionalProperties": false
  52. }
  53. },
  54. "required": ["address"],
  55. "additionalProperties": false
  56. }