Skip to content

03_queries.md

Latest commit

 

History

History
93 lines (59 loc) · 1.58 KB

03_queries.md

File metadata and controls

93 lines (59 loc) · 1.58 KB

Queries

Index

Endpoint: /noble/dollar/v1/index

Retrieves the current Noble Dollar Index from state.

{
  "index": "1.110100000000000000"
}

Response

  • index: — The current index of $USDN.

Paused

Endpoint: /noble/dollar/v1/paused

Retrieves the current paused state of the Noble Dollar.

{
  "paused": "true"
}

Response

  • paused — The paused state of the Noble Dollar.

Principal

Endpoint: /noble/dollar/v1/principal/{account}

Retrieves the principal amount associated with a $USDN holders account.

{
  "principal": "1000000"
}

Arguments

  • account — The address of the holder you wish to request the principal of.

Response

  • principal — The current principal amount held by the requested account.

Stats

Endpoint: /noble/dollar/v1/stats

Retrieves the latest stats of Noble Dollar.

{
  "total_holders": "1000",
  "total_principal": "100000",
  "total_yield_accrued": "100"
}

Response

  • total_holders: — The total number of $USDN holders.
  • total_principal: — The total principal amount in the system.
  • total_yield_accrued: — The total amount of yield that has been accrued over time.

Yield

Endpoint: /noble/dollar/v1/yield/{account}

Retrieves the amount of yield that is claimable for a $USDN holder.

{
  "claimable_amount": "50000"
}

Arguments

  • account — The address of the holder you wish to request the yield of.

Response

  • claimable_amount — The current amount of yield claimable by the requested account.