Differences

This shows you the differences between two versions of the page.

--- api_calls [03/15/2021 16:52] – marracc
+++ api_calls [01/14/2022 23:28] – gfactor
@@ Line 1: / Line 1: @@
 ====== API Calls ======
+{{:qortal_official_logo_transparent_.png?400|}}
-You need to have enabled API documentation in your settings.json file for using API calls.
+**Please note: the API calls are universal. They will work on any operating system. You need to have enabled API documentation in your settings.json file for using API calls. You can only run these calls on the computer acting as a node which will need to be fully synced!**
-Here is the line:
+**Here is the line:**
 "apiDocumentationEnabled": true
 List of mostly used API calls:
-Your Qortal Node API Documentation/Access:
+**Your Qortal Node API Documentation/Access:**
 http://localhost:12391/api-documentation/
-Your core block chain height, core status (minting or syncing), number of connected nodes:
+**Your core block chain height, core status (minting or syncing), number of connected nodes:
+**
 http://localhost:12391/admin/status
-Your Qortal Node Admin Information (your up time & Build Version):
+**Your Qortal Node Admin Information (your up time & Build Version):
+**
 http://localhost:12391/admin/info
-Your Qortal Node Information (Address, PublicKey, Blocks Minted):
+**Your Qortal Node Information (Address, PublicKey, Blocks Minted):
+**
 http://localhost:12391/addresses/(INPUT_YOUR_ADDRESS)
-Adding new peer to your DB:
+**Adding new peer to your DB:
+**
 http://localhost:12391/api-documentation/#/Peers/addPeer
+**Ditch chain to set height:**
 If your core is stuck at some height, you can try to ditch blocks to some height and re-sync from there.
-You are inputting height to ditch to. If you will input 300000, your core will drop blocks up to 300000 and then start to sync from that:
+You are inputting height to ditch to. If you will input 300000, your core will drop blocks up to 300000 and then start to sync from that height and catch back up to the right height. If during the roll back you notice its getting slower or stalling, just close core and repeat steps, sometimes you need to repeat the steps a couple to roll back to your desired block quickly:
 http://localhost:12391/api-documentation/#/Admin/orphan
+**Version 3.0 & the 'API Key'**
+In **core version 3.0.1** and beyond, there is now an 'apikey.txt' file that is created by the UI when accessing the Qortal core. This file is located in the qortal core folder. You will need to utilize this file with 'sensitive' API calls in order to make them function.
+Any API call that has the **X-API-KEY** section in it, will require the API key to be input in order to function. For calls that have that, simply open the **apikey.txt**, copy the API key, and put in the API key into that field when making the call. If you do not do this, the call will not function.

Qortal Project

User Tools

Site Tools

Differences

Page Tools