Factoid API

Note: This documentation is outdated. The latest documentation is located here: https://docs.factom.com/api

This document does a quick summary of the API for Factoids and the Factoid wallet. At this point in time the wallet is a commandline driven program, intended to demonstrate the API more than to be a viable commerical wallet solution.

The first step is to install the factom client and factom wallet helpers. See the How To guides for setting up in your environment. You will need to run factomd and fctwallet. Note that from time to time over the next few months you will need to update factomd to continue to communicate with the network. Watch our technical blog for notifications and updates.

The two APIs that are of interest are implemented by factomd and fctwallet. The first, factomd, is the client program that actually participates in the Factom Network. The second, fctwallet, provides common wallet functions, and it maintains the address book where private keys are kept. A third program, walletapp, provides for cold wallets, the generation of offline transactions, and the submission of offline transactions to the factom network.

The factom client factomd provides a RESTful interface found at http://localhost:8088 by default. None of the calls to factomd present any security issues, so factomd does not have to be colocated with programs creating and submitting transactions.

The factom wallet fctwallet provides a RESTful interface found at http://localhost:8089 by default. Calls to fctwallet allow for the creation of transactions against factoid addresses held in its wallet. Access to the API then must be kept secure.

The factom wallet walletapp is an alternative that only supports factoid functions. It communicates only with factomd. The walletapp supports cold storage, construction of offline transactions, and the submission of offline transaction to the factom network. We will soon be releasing a GUI that will run on top of the walletapp that will provide support for general factoid users.

The factom commandline wallet factom-cli is a wallet that supports factoid transactions, as well as general access to the Factom protocol. factom-cli uses the interfaces to factomd and fctwallet to implement its functionality. The main purpose of this program is to demonstrate the use of the factom APIs. It can also be used to script transaction processes against Factom.

Note: Examples of the API calls provided below can be executed in command line directly if curl is installed. The API calls have been prefixed with curl -X POST or curl -X GET depending on method.

factomd

This is a summary of the factomd API as pertains to trading Factoids. We will add detail on other calls as we go forward.

Post http://localhost:8088/v1/commit-chain/?

Commits a chain. The first step towards creating a new chain.

fctwallet API 'compose-chain-submit' needs to be called first to get the CommitChainMsg which is the input for this API. For Example:

A call to compose-entry-submit API returns a JSON object
```
$ curl -X POST -H 'Content-Type: application/json' -d '{"ExtIDs":["466972737421", "7365636F6E64"], "Content":"48656C6C6F20466163746F6D21"}' localhost:8089/v1/compose-chain-submit/entrycreditaddressname
```
Returns

{"ChainID":"28590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610","ChainCommit":{"CommitChainMsg":"00015386f1252f4f0db4ade591a7669451540daaaa77b21fef2881989729725c94a9ab44675e6a6e26695e5aa298fa3a7454d95960336c9ecb1b9a2fb30fba95996e193e26b8cc9e9a6f90bd86564bcc453055eac484a67794714a573dd969df4526daf0a971f80b3b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da2986deafdec8e0933e755e884fc16f71d52febcb3f0e6f00b1642b3332afac0f78c755b1588793cd4ce103c91031e73aed381c7cb55c5585640524123fd00e6c00"},"EntryReveal":{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b476100010000646697273742100067365636f6e6448656c6c6f20466163746f6d21"}}

The return value contains both the ChainCommit and the Entry Reveal. To Commit the Entry:

$ curl -i -X POST -H 'Content-Type: application/json' -d '{"CommitChainMsg":"00015386f1252f4f0db4ade591a7669451540daaaa77b21fef2881989729725c94a9ab44675e6a6e26695e5aa298fa3a7454d95960336c9ecb1b9a2fb30fba95996e193e26b8cc9e9a6f90bd86564bcc453055eac484a67794714a573dd969df4526daf0a971f80b3b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da2986deafdec8e0933e755e884fc16f71d52febcb3f0e6f00b1642b3332afac0f78c755b1588793cd4ce103c91031e73aed381c7cb55c5585640524123fd00e6c00"}' localhost:8088/v1/commit-chain

To Reveal the First Entry:

$ curl -i -X POST -H 'Content-Type: application/json' -d '{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b476100010000646697273742100067365636f6e6448656c6c6f20466163746f6d21"}' localhost:8088/v1/reveal-entry

The Chain gets committed and first entry is made.
Post http://localhost:8088/v1/reveal-chain/?

Reveal the first entry in a chain. Required to complete the construction of a new chain. The format of the API call is covered above.
Post http://localhost:8088/v1/commit-entry/?

Commits an entry. The first step in writing an entry to a chain.

fctwallet API 'compose-entry-submit' needs to be called first to get the CommitEntryMsg which is the input for this API. For Example:

A call to compose-entry-submit API returns a JSON object
```
$ curl -i -X POST -H 'Content-Type: application/json' -d '{"ChainID":"28590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610", "ExtIDs":["657831", "657832"], "Content":"48656C6C6F20466163746F6D21"}' localhost:8089/v1/compose-entry-submit/entrycreditaddressname
```
Returns

{"EntryCommit":{"CommitEntryMsg":"000153872b030f7ad8b3722c6f72508df028d0f2563cc711e0ccd7da749160e3d385216237b065013b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da29102270e0584dbe4c872980b7d6cb569d4fc35310b81219253b5b1e333d44ede92418fcddc61f9149cda737dcb6ebf3f5742327b42e9ce8bce08c697e6fdcda0b"},"EntryReveal":{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610000a0003657831000365783248656c6c6f20466163746f6d21"}}

The return value contains both the EntryCommit and the Entry Reveal. To Commit the Entry:

$ curl -i -X POST -H 'Content-Type: application/json' -d '{"CommitEntryMsg":"000153872b030f7ad8b3722c6f72508df028d0f2563cc711e0ccd7da749160e3d385216237b065013b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da29102270e0584dbe4c872980b7d6cb569d4fc35310b81219253b5b1e333d44ede92418fcddc61f9149cda737dcb6ebf3f5742327b42e9ce8bce08c697e6fdcda0b"}' localhost:8088/v1/commit-entry

Then Reveal the Entry:

$ curl -i -X POST -H 'Content-Type: application/json' -d '{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610000a0003657831000365783248656c6c6f20466163746f6d21"}' localhost:8088/v1/reveal-entry

The entries are made to the ChainID provided.

Note: ChainName can be provided instead of ChainID. However if the ChainID field has data, the ChainName field will be ignored.

example json entry: {"ChainName":["466972737421", "7365636F6E64"], "ExtIDs":["657831", "657832"], "Content":"48656C6C6F20466163746F6D21"}

is the same as

{"ChainID":"28590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610", "ExtIDs":["657831", "657832"], "Content":"48656C6C6F20466163746F6D21"}

Post http://localhost:8088/v1/reveal-entry/?

Reveal a new entry. Required to complete the writing of an entry into a chain. Format of the API call is covered above.

Post http://localhost:8088/v1/factoid-submit/?

Submit transaction. Requires the encoded transaction as part of the call. For example, creating a transaction that sends 10 factoids from xxx to yyy might be encoded as:

curl -X POST -H 'Content-Type: application/json' -d '{"Transaction":"0201538741213601000183e0d3b160646f3e8750c550e4582eca5047546ffef89c13a175985e320232bacac81cc42883dceb94003b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da2901718b5edd2914acc2e4677f336c1a32736e5e9bde13663e6413894f57ec272e2830312c70f7aafecb55846014600f08eb8fe39b97e977ade4d86e1d6a6164af9ee1bda806fbdfc04db9bcc6c1bece954cfd9ed41defadf3505c14a532191f4d09"}' http://localhost:8088/v1/factoid-submit/

That seems like a pretty complex construction of data. Most users will use fctwallet to construct this call.

Get http://localhost:8088/v1/directory-block-head/?

Returns the hash of the directory block head. No parameters are needed. Returns a JSON string of the form:
```
{"KeyMR":"f7eb0456b30b1a4b50867a5307532e92ddee7279ffc955ce1284cd142f94d642"}
```
Get http://localhost:8088/v1/directory-block-height/?

Returns the current directory block height.
```
curl -X GET http://localhost:8088/v1/directory-block-height/
```
Returned at the time of writing:
```
{"Height":4585}
```

Get http://localhost:8088/v1/get-raw-data/([^/]+)

Returns the block assoicated with the given hash.

curl -X GET http://localhost:8088/v1/get-raw-data/f7eb0456b30b1a4b50867a5307532e92ddee7279ffc955ce1284cd142f94d642

returns:

{"Data":"00fa92e5a291592f5f78c547560edceb8bc5ef142f20e9689fcd587557a2f3d18406d6e5ece9eacaa1c31d1371af60d6a9d5ea65654d1ff5698f7fb181d0ae4bc8582c093186dd2a14e83bbf53bb7cab230b1d0e2cefbb0d93d16c09c39ea13e338d0a8c0a016f279a000010c100000004000000000000000000000000000000000000000000000000000000000000000a98f7817976ed8ff9aa306834d98c145d7c0334d7057f89dd2f035df1b37946ae000000000000000000000000000000000000000000000000000000000000000c9432448e6c7f56450804b42ed9c1653182efb6f48a5d8da2c22d1789e7dbff44000000000000000000000000000000000000000000000000000000000000000fb642daa292af42dda109bc87cddd31647da6fef9f3f25129c3740ef4d72761a0df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604789b0103e5f8358d7f8402264837986a2b29ac59be8a796dbbe75eecf6a853d9"}

This data can be unmarshalled into the directory block struct used by Factom.

Get http://localhost:8088/v1/directory-block-by-keymr/([^/]+)

Returns the directory block assoicated with the given hash.

curl -X GET http://localhost:8088/v1/directory-block-by-keymr/f7eb0456b30b1a4b50867a5307532e92ddee7279ffc955ce1284cd142f94d642

returns:

{"Header":{
   "PrevBlockKeyMR":"e9eacaa1c31d1371af60d6a9d5ea65654d1ff5698f7fb181d0ae4bc8582c0931",
   "SequenceNumber":4289,
   "Timestamp":1443711000},
   "EntryBlockList":[
      {"ChainID":"000000000000000000000000000000000000000000000000000000000000000a",
       "KeyMR":"98f7817976ed8ff9aa306834d98c145d7c0334d7057f89dd2f035df1b37946ae"},
      {"ChainID":"000000000000000000000000000000000000000000000000000000000000000c",
       "KeyMR":"9432448e6c7f56450804b42ed9c1653182efb6f48a5d8da2c22d1789e7dbff44"},
      {"ChainID":"000000000000000000000000000000000000000000000000000000000000000f",
       "KeyMR":"b642daa292af42dda109bc87cddd31647da6fef9f3f25129c3740ef4d72761a0"},
      {"ChainID":"df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604",
       "KeyMR":"789b0103e5f8358d7f8402264837986a2b29ac59be8a796dbbe75eecf6a853d9"}
  ]
}

This call returns the data held in a Directory Block digested into a JSON structure.

Get http://localhost:8088/v1/entry-block-by-keymr/([^/]+)

Returns an Entry Block structure. The call:

curl -X GET http://localhost:8088/v1/entry-block-by-keymr/789b0103e5f8358d7f8402264837986a2b29ac59be8a796dbbe75eecf6a853d9

Returns

{
  "Header":{
    "BlockSequenceNumber":2479,
    "ChainID":"df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604",
    "PrevKeyMR":"63833701a61a846ebe8d38a1c6ede6bf5d5516990c34372c7f7936812ec09bde",
    "Timestamp":1443711000
  },
  "EntryList":[
      { "EntryHash":"c8f4936962836cda0d8bf712653d97f8d8b5cbe675e495b6dfab6b2395c8b80a",
        "Timestamp":1443711360
      }
  ]
}

This is the structure of an Entry block, broken out into JSON.

+ Get **http://localhost:8088/v1/entry-by-hash/([^/]+)", handleEntry)**

  Returns an Entry broken out into JSON.  The following call:

curl -X GET http://localhost:8088/v1/entry-by-hash/c8f4936962836cda0d8bf712653d97f8d8b5cbe675e495b6dfab6b2395c8b80a

Returns:

{"ChainID":"df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604", "Content":"7b22416e63686f725265636f7264566572223a312c224442486569676874223a343238382c224b65794d52223a2265396561636161316333316431333731616636306436613964356561363536353464316666353639386637666231383164306165346263383538326330393331222c225265636f7264486569676874223a343238382c22426974636f696e223a7b2241646472657373223a22314b3253586741706d6f39755a6f79616876736253616e705657627a5a5756564d46222c2254584944223a2263323363623932303764356266643863376539656565303438316338333563663463373665626132363565393832656330623032353964636666323536636134222c22426c6f636b486569676874223a3337373031312c22426c6f636b48617368223a2230303030303030303030303030303030303466396138653735343065383135316336373231653131646264343166633936663931653432313661373161356334222c224f6666736574223a3835317d7d6234643966633530343564653635313532353664623337316463633138636266653761616537383664326262336565633466316334373966636132393762373266363330633261313439366436653737653139633631626165663030326233396133633064656534636439323963396335393836326331366639646136353033","ExtIDs":null}

Returns a particiular Entry's construction broken out into JSON.

+ Get **http://localhost:8088/v1/chain-head/([^/]+)**

Returns the KeyMR of the first Entry in an Entry Chain.  The call:

curl -X GET http://localhost:8088/v1/chain-head/df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604

Returns

{"ChainHead":"bfd814a3b9a4356e04c816fe4ce1a53198953ab321912d60dacba766950e5591"}


+ Get **http://localhost:8088/v1/entry-credit-balance/([^/]+)**

Returns the balance at the given Entry Credit address.  For example, the call:

curl -X GET http://localhost:8088/v1/entry-credit-balance/748be8327d20fee4365e6b5a3dca7df1e59da47e9ebd99129ba84d58d4d0726b

Might return (depending on the balance at that address at the time):

{"Response":"4000","Success":true}

This would indicate that the decoded Entry Credit address (EC2eUoDPupuQXm5gxs1sCBCv3bbZBCYFDTjaFQ6iRaAKfyXNqjEJ) decodes to the hex: 748be8327d20fee4365e6b5a3dca7df1e59da47e9ebd99129ba84d58d4d0726b and has a balance of 4000 entry credits.

+ Get **http://localhost:8088/v1/factoid-balance/([^/]+)**

Returns the Factoid balance at the given address.  For example, the call:

curl -X GET http://localhost:8088/v1/factoid-balance/f6e117ea838cb652e9cfc3b29552d5887800a7ba614df0bd8c13e171eddc5897

Returns:

{"Response":"1210268000","Success":true}

Note that, like Bitcoin, Factoids use fixed point to indicate parts of a coin.  so 1210268000 represents 12.10268 factoids.

+ Get **http://localhost:8088/v1/factoid-get-fee/**

Returns the current exchange rate for Entry Credits.  So the call:

curl -X GET http://localhost:8088/v1/factoid-get-fee/

might return

{"Fee":100000}

indicating that .001 Factoids will purchase 1 Entry Credit.   

+ Get **http://localhost:8088/v1/properties/",handleProperties)**

Returns the version numbers of various components of Factom.  For example at the time of writing, the call:

curl -X GET http://localhost:8088/v1/properties/

Returns:

{ "Protocol_Version":1005, "Factomd_Version":3002, "Fctwallet_Version":0 }


fctwallet
---------

+	Get **http://localhost:8089/v1/factoid-balance/([^/]+)**

Return the factoid balance at the given Factoid address.  The call can take an address name known by your wallet, a Factoid address, or a hex representation of the address (less base 58 and checksums).

For example, for a given wallet, the following calls:

curl -X GET "http://localhost:8089/v1/factoid-balance/FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" curl -X GET "http://localhost:8089/v1/factoid-balance/9e72fa1dbdac30b557c857a1dcdca04b4ae748e52dc492e1f85f6af6f29f6534"
curl -X GET "http://localhost:8089/v1/factoid-balance/FactomAddress01"

Will return:

{"Response":"1210680000","Success":true}

Should all retrieve the same balance from the same address, assuming that your address book had an entry FactomAddress01 with the private key for FA3ArvkijVcgrFVj45PBgGBfWm1MWAEjV1SbVxSFiUNT6s9F7AQb.

+	Get **http://localhost:8089/v1/entry-credit-balance/([^/]+)**

Return the Entry Credit balance for the specified address.  The call can take an address name known by your wallet, an Entry Credit address, or a hex representation of the address (less base 58 and checksum).

For example, for a given wallet and Entry Credit address, the calls:

curl -X GET "http://localhost:8089/v1/entry-credit-balance/ECxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" curl -X GET "http://localhost:8089/v1/entry-credit-balance/748be8327d20fee4365e6b5a3dca7df1e59da47e9ebd99129ba84d58d4d0726b" curl -X GET "http://localhost:8090/EntryCreditAddress001"

Will Return

{"Response":"4000","Success":true}

Assuming that your wallet had an entry EntryCreditAddress001 with the private key for the given public address.

+	Get **http://localhost:8089/v1/factoid-generate-address/([^/]+)**

Generate an address, and create an entry in your wallet to hold said address.  Addresses are created from a deterministic hash, so if you back up your wallet, then your wallet can be restored even if some of the addresses were created after the backup.

The call:

curl -X GET "http://localhost:8089/v1/factoid-generate-address/fctAddress0001"

will create an address fctAddress0001, and assign it a new private key.

+ Get **http://localhost:8089/v1/factoid-generate-ec-address/([^/]+)**

Generate an Entry Credit address, and create an entry in your wallet to hold said address.  Addresses are created from a deterministic hash, so if you back up your wallet, then your wallet can be restored even if some of the addresses were created after the backup.

The call:

curl -X GET "http://localhost:8089/v1/factoid-generate-ec-address/ECAddress0001"

will create an address ECAddress0001, and assign it a new private key.

+	Get **http://localhost:8089/v1/factoid-generate-address-from-private-key/(.*)**
  
This call is used to import a factoid private key in hex from another source.  Provided a private key and a name. For example:

curl -X GET "http://localhost:8089/v1/factoid-generate-address-from-private-key/?name=addr001&privateKey=85d6755c286c6f139b1696ca74b0c14da473beadc37b2ec6273f2a92ce8d7c88"

would import the given private key, and store it in the wallet under addr001 and return the public key.  Note that importing private keys in this fashion requires a fresh backup of the wallet for safety.
 
+	Get **http://localhost:8089/v1/factoid-generate-ec-address-from-private-key/(.*)**

 This call is used to import an entry credit private key in hex from another source.  Provided a private key and a name. For example:

curl -X GET "http://localhost:8089/v1/factoid-generate-ec-address-from-private-key/?name=addr001&privateKey=3ffa892f2445286a06c0dc591d7fa557d16701e44ec1cbee2930f7d7dfb62d57"

would import the given private key, and store it in the wallet under addr001 and return the public key. Note that importing private keys in this fashion requires a fresh backup of the wallet for safety.

+	Get **http://localhost:8089/v1/factoid-generate-address-from-human-readable-private-key/(.*)**
 
This call is used to import a factoid private key in human readable form from another source.  Provided a private key and a name. For example:

curl -X GET "http://localhost:8089/v1/factoid-generate-address-from-human-readable-private-key/?name=addr001&privateKey=Fsxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"


 would import the given private key, and store it in the wallet under addr001 and return the public key.  Note that importing private keys in this fashion requires a fresh backup of the wallet for safety.
   
+	Get **http://localhost:8089/v1/factoid-generate-ec-address-from-human-readable-private-key/(.*)**

 This call is used to import an Entry Credit private key in human readable form from another source.  Provided a private key and a name. For example:

curl -X GET "http://localhost:8089/v1/factoid-generate-address-from-human-readable-private-key/?name=addr001&privateKey=Esxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

would import the given private key, and store it in the wallet under addr001 and return the public key. Note that importing private keys in this fashion requires a fresh backup of the wallet for safety.

+	Get **http://localhost:8089/v1/factoid-generate-address-from-token-sale/(.*)**

Accepts the 12 words provided by Koinify during the crowd sale, and generates the corresponding entry in the wallet. For example:

curl -X GET "http://localhost:8089/v1/factoid-generate-address-from-token-sale/?name=koinifyAddr&mnemonic=<12 words separated by %20>"

Returns the public key

+	Post **http://localhost:8089/v1/factoid-new-transaction/([^/]+)**

Creates a new transaction, and assoicates that transaction with a key.  This key is used in other operations to add inputs, add outputs, add entry credit outputs, pay the fee, sign the transaction, and submit it. Example:

curl -X POST "http://localhost:8089/v1/factoid-new-transaction/trans"

Response

{"Response":"Success building a transaction","Success":true}

Which creates a transaction named 'trans'.  We will use this transaction in the following commands.

+	Post **http://localhost:8089/v1/factoid-delete-transaction/([^/]+)**

Delete the specified transaction under construction by name.

curl -X POST "http://localhost:8089/v1/factoid-delete-transaction/trans"

Response

{"Response":"Success deleting transaction","Success":true}


Removes the transaction 'trans'.  To continue to build a transaction named trans, you would need to recreate 'trans'.

+	Post **http://localhost:8089/v1/factoid-add-fee/(.*)**

Add the needed fee to the given transaction.  This call calculates the needed fee, and adds it to the specified input.  The inputs and outputs must be exactly balanced, because this call isn't going to mess with unbalanced transactions as how to balance can be tricky.

curl -X POST http://localhost:8089/v1/factoid-add-fee/ -d "key=trans&name=FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

{"Response":"Added 0.153318 to FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","Success":true}


Assuming the given Factoid address is an input to trans, this adds the fee to that address.

+	Post **http://localhost:8089/v1/factoid-add-input/(.*)**

Add the given input to the transaction specified.

curl -X POST http://localhost:8089/v1/factoid-add-input/ -d "key=trans&name=FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&amount=10000000"

Response

{"Response":"Success adding Input","Success":true}

Adds an input from the given address to the transaction trans.  The number of factoids (12) will be presented in fixpoint notation, i.e. (1200000000)

+	Post **http://localhost:8089/v1/factoid-add-output/(.*)**

Add the given output to the transaction specified.

curl -X POST http://localhost:8089/v1/factoid-add-output/ -d "key=trans&name=FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&amount=10000000"

Response

{"Response":"Success adding output","Success":true}


Adds an output to the given address to the transaction trans.  The number of factoids (13) will be presented in fixpoint notation, i.e. (1300000000)

+ Post **http://localhost:8089/v1/factoid-add-ecoutput/(.*)**

Add the given Entry Credit Output to the transaction specified.  Note that Entry Credit Outputs are denominated in Factoids.  How many Entry Credits are alloted depends upon the exchage rate of factoids to entry credits in place at the time of the transaction.  For example:

curl -X POST http://localhost:8089/v1/factoid-add-ecoutput/ -d "key=trans&name=ECxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&amount=10000000"

Response

{"Response":"Success adding Entry Credit Output","Success":true}

Adds an ecoutput to the given entry credit address to the transaction trans. Assume a factoid to Entry Credit exchange rate of .001.  Then the number of Entry Credits (1000) will be determined by the factoids in the output (1) divided by the factoid to entry credit rate (.001).  The factoids converted to entry credits will be presented in fixpoint notation, i.e. (100000000 == 1 factoid)

+ Post **http://localhost:8089/v1/factoid-sign-transaction/(.*)**

Sign the given transaction.

curl -X POST "http://localhost:8089/v1/factoid-sign-transaction/trans"

Response

{"Response":"Success signing transaction","Success":true}

Signs the transaction 'trans'.

+ Post **http://localhost:8089/v1/compose-chain-submit/([^/]+)**

Create a JSON object that may be used in the factomd calls to commit-chain and reveal-chain

  $ curl -X POST -H 'Content-Type: application/json' -d '{"ExtIDs":["466972737421", "7365636F6E64"], "Content":"48656C6C6F20466163746F6D21"}' localhost:8089/v1/compose-chain-submit/app
  
Returns
  
  {"ChainID":"28590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610","ChainCommit":{"CommitChainMsg":"0001538758c38a4f0db4ade591a7669451540daaaa77b21fef2881989729725c94a9ab44675e6a6e26695e5aa298fa3a7454d95960336c9ecb1b9a2fb30fba95996e193e26b8cc9e9a6f90bd86564bcc453055eac484a67794714a573dd969df4526daf0a971f80b3b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da292a6501852426d8ebc44b74bc0da4e99bd4a50faa383cf0c4ea6f5d7dfb4561829614c9932cec66eb588becc2cab874cc17649f6fb67f87b9b5b45aa0503db90f"},"EntryReveal":{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b476100010000646697273742100067365636f6e6448656c6c6f20466163746f6d21"}}
  
+ Post **http://localhost:8089/v1/compose-entry-submit/([^/]+)**

Create a JSON object that may be used in the factomd calls to commit-entry and reveal-entry

  $ curl -i -X POST -H 'Content-Type: application/json' -d '{"ChainID":"28590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610", "ExtIDs":["657831", "657832"], "Content":"48656C6C6F20466163746F6D21"}' localhost:8089/v1/compose-entry-submit/app

Returns

  {"EntryCommit":{"CommitEntryMsg":"000153876694327ad8b3722c6f72508df028d0f2563cc711e0ccd7da749160e3d385216237b065013b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da297a7a050663fd071f2d61c7fbdddfc5f47364a03767110cd20dfd59112d5c470f150a7a281a84e784680a7be7cc45ceee516eebb7a199a0d77cafcb9ef7fa5809"},"EntryReveal":{"Entry":"0028590424cc9dbe8957e576c492befff899274757658e2db14b3b34c646b47610000a0003657831000365783248656c6c6f20466163746f6d21"}}

+ Post **http://localhost:8089/v1/commit-chain/([^/]+)**

Sign a binary Chain Commit with the specified entry credit key and submit it to the factomd server 

+ Post **http://localhost:8089/v1/commit-entry/([^/]+)**

Commit an entry to an Entry Chain 

+ Post **http://localhost:8089/v1/factoid-submit/(.*)**

Submit a transaction to Factom. This call takes a named JSON parameter.  For example, to submit a transaction named trans, you need the following call:

curl -X POST http://localhost:8089/v1/factoid-submit/\\{\"Transaction\":\"trans\"\\}

Response

{"Response":"Success Submitting transaction","Success":true}


+ Get **http://localhost:8089/v1/factoid-validate/(.*)**	

Not currently implemented.

+ Get **http://localhost:8089"/v1/factoid-get-fee/(.*)**

Get the current exchange rate in number of Factoids per Entry Credit
For example:

curl -X GET "http://localhost:8089/v1/factoid-get-fee/"

Response

{"Response":"0.006666","Success":true}


+ Get **http://localhost:8089"/v1/properties/**

Get the version numbers of all the components of the Factom client, fctwallet, factomd, and the protocol
For example:

curl -X GET "http://localhost:8089/v1/properties/"

Response

{"Response":"Protocol Version: 0.1.5\nfactomd Version: 0.3.4\nfctwallet Version: 0.1.4\n","Success":true}


+ Get **http://localhost:8089/v1/factoid-get-addresses/**

Get the address list held in the wallet
For example:

curl -X GET "http://localhost:8089/v1/factoid-get-addresses/"


+ Get **http://localhost:8089/v1/factoid-get-transactions/**

Get all the transactions currently under construction, along with the key used to reference them.
For example:

curl -X GET "http://localhost:8089/v1/factoid-get-transactions/"


+ Post **http://localhost:8089/v1/factoid-get-processed-transactions/(.*)**

If pass in 'all' then all transactions are returned.  If an address, then all the transactions that use the address as an input, output, or entry credit output will be returned.  The transactions are returned as text.
For example:

curl -X POST http://localhost:8089/v1/factoid-get-processed-transactions/ -d "address=FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" curl -X POST http://localhost:8089/v1/factoid-get-processed-transactions/ -d "address=" curl -X POST http://localhost:8089/v1/factoid-get-processed-transactions/ -d "cmd=all"


+ Post **http://localhost:8089/v1/factoid-get-processed-transactionsj/(.*)**

  If pass in 'all' then all transactions are returned.  If an address, then all the transactions that use the address as an input, output, or entry credit output will be returned.  The transactions are returned as an array of JSON objects. The block range can also be optionally specified with start and end block heights.
  For example:

curl -X POST http://localhost:8089/v1/factoid-get-processed-transactionsj/ -d "address=FAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" curl -X POST http://localhost:8089/v1/factoid-get-processed-transactionsj/ -d "address=" curl -X POST http://localhost:8089/v1/factoid-get-processed-transactionsj/ -d "cmd=all" curl -X POST http://localhost:8089/v1/factoid-get-processed-transactionsj/ -d "cmd=all&start=25400&end=25415"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FactoidAPI.md

FactoidAPI.md

Factoid API

factomd

Files

FactoidAPI.md

Latest commit

History

FactoidAPI.md

File metadata and controls

Factoid API

factomd