tacyarg/Fundingrate_Docs.md

## Fundingrate_Docs.md

      
    Raw
  

              Fundingrate_Docs.md
            
          
    ping

Endpoint: GET - https://api.fundingrate.io/v2/
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

{}

Public

echo

Endpoint: POST - https://api.fundingrate.io/v2/public/echo
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

{
	"nig": "yo",
	"taco": "yes"
}

listProviders

Endpoint: POST - https://api.fundingrate.io/v2/public/listProviders
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

{}

Auth

setToken

Endpoint: POST - https://api.fundingrate.io/v2/auth/setToken
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

{
	"tokenid": "fundingrate"
}

token

Endpoint: POST - https://api.fundingrate.io/v2/auth/token
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

{}

authenticate

Endpoint: POST - https://api.fundingrate.io/v2/auth/authenticate
Description: N/A
Header

{
	Content-Type: application/json; charset=utf-8
}

Body

[
	"33ced7e4-a40e-4402-a412-3d5bc9b7312a"
]

logout

Endpoint: POST - https://api.fundingrate.io/v2/auth/logout
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

[]

login

Endpoint: POST - https://api.fundingrate.io/v2/auth/login
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"login": "test@test.com",
	"token": "33ced7e4-a40e-4402-a412-3d5bc9b7312a",
	"password": "test"
}

signup

Endpoint: POST - https://api.fundingrate.io/v2/auth/signup
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"login": "test@test.com",
	"token": "33ced7e4-a40e-4402-a412-3d5bc9b7312a",
	"password": "test"
}

Private

me

Endpoint: POST - https://api.fundingrate.io/v2/private/me
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{}

setMyUsername

Endpoint: POST - https://api.fundingrate.io/v2/private/setMyUsername
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"username": "tacy"
}

createProvider

Endpoint: POST - https://api.fundingrate.io/v2/private/createProvider
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"name": "test 01",
	"description": "test description"
}

listMyAlerts

Endpoint: POST - https://api.fundingrate.io/v2/private/listMyAlerts
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{}

listMyProviders

Endpoint: POST - https://api.fundingrate.io/v2/private/listMyProviders
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{}

listMyTokens

Endpoint: POST - https://api.fundingrate.io/v2/private/listMyTokens
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{}

generateToken

Endpoint: POST - https://api.fundingrate.io/v2/private/generateToken
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"description": "something relative"
}

removeToken

Endpoint: POST - https://api.fundingrate.io/v2/private/removeToken
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"tokenid": "bf4349be-a815-46c5-bb3b-b8f8afa6a0a8"
}

Provider

consumeEvent

Endpoint: POST - https://api.fundingrate.io/v2/provider/consumeEvent
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"ticker": "XBTUSD",
	"condition": "Buy Alert",
	"candles": "Heikin Ashi",
	"exchange": "BITMEX",
	"price": 5323.875,
	"timeframe": "1m",
	"type": "LONG",
	"description": "Range Bottom",
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

listAlerts

Endpoint: POST - https://api.fundingrate.io/v2/provider/listAlerts
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

setPublic

Endpoint: POST - https://api.fundingrate.io/v2/provider/setPublic
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

setPrivate

Endpoint: POST - https://api.fundingrate.io/v2/provider/setPrivate
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

setName

Endpoint: POST - https://api.fundingrate.io/v2/provider/setName
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"name": "Testing a new name",
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

setDescription

Endpoint: POST - https://api.fundingrate.io/v2/provider/setDescription
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"description": "# Test",
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

getStats

Endpoint: POST - https://api.fundingrate.io/v2/provider/getStats
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}

listTrades

Endpoint: POST - https://api.fundingrate.io/v2/provider/listTrades
Description: N/A
Header

{
	Authorization: Bearer 33ced7e4-a40e-4402-a412-3d5bc9b7312a
	Content-Type: application/json; charset=utf-8
}

Body

{
	"providerid": "00760b82-42b9-412d-8be1-bbc63b3930eb"
}