Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.94 KB

File metadata and controls

32 lines (26 loc) · 1.94 KB

apiInfo

get

Gets general information about the Connect API.

Sample

const apiInfo = await factomConnectSDK.apiInfo.get();

Parameters

Name Type Description SDK Error Message & Description
params.accessToken object
Optional
This is the override parameter that allows user to specify the following two authentication parameters which will override the same parameters which have already been set on the instantiation of the SDK class
* appId (string)
* appKey (string)
params.baseUrl string
Optional
This is the override parameter that allows user to specify a different API Base URL for your application (which you can see by clicking on any of the applications in the application list the you see upon logging into https://account.factom.com)

Returns

Response: OK

  • version: string
    Current version of the Connect API.
  • links: object
    Links to internal paths of the application.
    • links.chains: string
      The link to chain API.
{
   'version':'1.0.17',
   'links':{
      'chains':'/v1/chains'
   }
}