fishcoins api

you use GET along with various urls with parameters, listed below

• responses are in JSON
• the base url is https://fisheater.peterdance.com/fishcoin/api.php

yes i used php burn me on the stake

i have no idea why it's so slow

endpoints

✎ generate your wallet

?genwallet&name=<wallet holder name>

• each wallet begins with no fishcoin, a wallet name, and a wallet key. do not lose it!
• names are 20 char max, letters only, and must be original
• success response:

  { "wallet_key": "<key>" }

• fail response:

  { "error": "invalid_name" }

↙ collect payment

?collect&key=<your wallet key>&code=<code>

• collect payments using codes
• success response:

  {
    "new_balance": <amount>,
    "amount_received": <value>,
    "receipt_message": "<optional receipt message>",
    "receipt_img": "<optional receipt image>"
  }

• fail responses:

  { "error": "code_not_found" }

  { "error": "code_yields_no_coins" }

  { "error": "wallet_not_found" }

  { "error": "code_already_used" }

↗ generate payment code

?genpaycode&key=<your wallet key>&amount=<amount>&receipt-message=<receipt-msg>&receipt-img=<img-id>&equation=<equation>

• equations determine the final amount that each code brings. see the equation documentation for more info.
• if not using the wrapper, the images must be uploaded beforehand using the image upload tool
• success response:

  { "code": "<code>" }

• fail responses:

  { "error": "invalid_amount_or_equation" }

  { "error": "invalid_key" }

  { "error": "invalid_image_id" }

? gather information

?inquire&search=<search>

• enter a name to see their amount and rank, enter a wallet key to see your receipts, or enter a code to see what it's worth.
• search wallet name

  {
    "wallet": "<name>",
    "fishcoins": <amount>,
    "rank": <rank>,
    "total_wallets": <total>
  }

• search wallet key

  {
    "name": "<wallet_name>",
    "receipts": [
        {
            "receipt_message": "<optional_message>",
            "receipt_img": "<optional_image>",
            "timestamp": "<timestamp>",
            "peer": "<peer_wallet>",
            "amount": <value>
        }
    ]
  }
  

• search payment code

  {
    "creator": "<creator wallet>",
    "value": <value>
  }

• fail response:

  { "error": "not found" }

x remove payment code

?deletecode&code=<code>&key=<creator_wallet_key>

• deletes a payment code, useful for keeping the systems efficient.
• if you're creating an application that utilizes this api, consider deleting codes when they're no longer useful.
• success response:

  { "success": "code deleted successfully" }

• fail responses:

  { "error": "missing parameters. required: code, wallet_key." }

  { "error": "code not found." }

  { "error": "unauthorized. invalid wallet key." }

other (useful?) general info

• every payment code is a 9-character alpha-numeric string
• each wallet key is a 20-character alpha-numeric string
• the equations to determine amount are very powerful. you can use them to distribute things like freebies
• there are some freebie codes located around the website. they can be used once per wallet and will come from the mint until it runs dry.
• each wallet maintains a list of receipts for every transaction. you can see what each receipt includes in the example in gather information