Skip to content

Bitcoin Get Address Label

Xenland edited this page Dec 5, 2012 · 11 revisions

Back to API Call Index

Purpose

This function will open a connection with the Bitcoin client, then query bitcoin for the label that is associated with this address.

Parameter(s)

This function takes one parameter which is bitcoin_address and is optional.

Output | Array

This function outputs an array this array will output return_status , address_label , checksum_match , amount_due_in_satoshi , creation_of_receipt_timestamp.

return_status

  • Type: Integer

-1 = Failure to generate address

1 = Success (Address label successfully retrieved)

100 = Failure to connect to Bitcoin client

101 = Bitcoin was successfully connected to, but for unknown reasons we were unable to query the label..

102 = Checksum is not a match, don't trust any information = Address is too long or too short

address_label

  • Type: String

On return_status equals 1, this returns the label associated with this address.

checksum_match

  • Type: Binary (1 or 0)
  • Notes: 1 means the checksum is okay, 0 is non-valid checksum and don't trust any information from this saved receipt information if its zero.

On return_status equals 1, this will return 1 or zero.

amount_due_in_satoshi

  • Type: Integer
  • Notes: Multiply this integer by 100000000 and you will return the amount in Bitcoins.

On return_status equals 1, this will output how much this receipt says it is due before we can shipped the products

creation_of_receipt_timestamp

  • Type: Integer

On return_status equals 1, this will output when this receipt was created.