Chainlink Developers

Welcome to the Chainlink documentation site. You'll find comprehensive guides and documentation to help you start working with Chainlink as quickly as possible, as well as support if you get stuck. Click here for an introductory walkthrough on how to create a Chainlink request on the Ropsten test network!

Suggest Edits

Introduction

 

This API reference provides information on how to interact directly with a Chainlink node. If you are creating services which need direct communication with a Chainlink node, this information will be helpful for you. If you are wanting to connect an external resource (API) to a smart contract using Chainlink, please see the the Developers section of external adapters.

Suggest Edits

Account Balance

 
gethttp://localhost:6688/v2/account_balance
curl http://localhost:6688/v2/account_balance
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "accountBalances",
    "id": "0x5958C587503b40A8576998dB56C3F5ec1f024C3D",
    "attributes": {
      "address": "0x5958C587503b40A8576998dB56C3F5ec1f024C3D",
      "eth_balance": "2846227326000000000",
      "link_balance": "30215975358000000000"
    }
  }
}
 
Suggest Edits

Assignment

 
gethttp://localhost:6688/v1/assignments/:ID
curl -b cookiefile http://localhost:6688/v1/assignments/daf3a75233334f83a26a95a4b5e2b48f
A binary file was returned

You couldn't be authenticated

{
  "assignment": {
    "subtasks": [
      {
        "adapterType": "httpget",
        "adapterParams": {
          "confirmations": 0,
          "endpoint": "https://min-api.cryptocompare.com/data/price?fsym=BTC&tsyms=USD,JPY,EUR"
        }
      },
      {
        "adapterType": "jsonparse",
        "adapterParams": {
          "confirmations": 0,
          "fields": [
            "USD"
          ]
        }
      },
      {
        "adapterType": "ethereumbytes32",
        "adapterParams": {
          "confirmations": 0
        }
      }
    ]
  },
  "schedule": {
    "endAt": "2018-03-28T03:55:36Z",
    "hour": "0",
    "minute": "0",
    "dayOfMonth": null,
    "monthOfYear": null,
    "dayOfWeek": null,
    "runAt": null
  }
}
{
  "errors": [
    {
      "detail": "ID not found"
    }
  ]
}

Path Params

:ID
string
required

The assignment ID

 
Suggest Edits

Assignments

 
posthttp://localhost:6688/v1/assignments
curl -b cookiefile -X POST -H 'Content-Type: application/json' \
  -d '{"assignment":{"subtasks":[{"adapterType":"httpGet","adapterParams":{"endpoint":"https://min-api.cryptocompare.com/data/price?fsym=BTC&tsyms=USD,JPY,EUR"}},{"adapterType":"jsonParse","adapterParams":{"fields":["USD"]}},{"adapterType":"ethereumBytes32"}]},"schedule":{"endAt":"1522209336","hour":"0","minute":"0"},"version":"1.0.0"}' \
  http://localhost:6688/v1/assignments
A binary file was returned

You couldn't be authenticated

{
  "initiators": [
    {
      "type": "web"
    },
    {
      "type": "cron",
      "schedule": "0 0 0 * * *"
    }
  ],
  "id": "cf25d95fb48f48b38ebd5e8723029f9a",
  "createdAt": "2018-08-24T14:12:43.573909864-05:00",
  "tasks": [
    {
      "confirmations": 0,
      "endpoint": "https://min-api.cryptocompare.com/data/price?fsym=BTC&tsyms=USD,JPY,EUR",
      "type": "httpget"
    },
    {
      "confirmations": 0,
      "fields": [
        "USD"
      ],
      "type": "jsonparse"
    },
    {
      "confirmations": 0,
      "type": "ethereumbytes32"
    }
  ],
  "startAt": null,
  "endAt": "2018-03-28T03:55:36Z"
}

Body Params

assignment
object
required
schedule
object
version
string
 
gethttp://localhost:6688/v2/backup
curl -b cookiefile http://localhost:6688/v2/backup >> backup.db
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Bridge Type

 
deletehttp://localhost:6688/v2/bridge_types/:BridgeName
curl -v -b cookiefile -X DELETE http://localhost:6688/v2/bridge_types/pending
A binary file was returned

You couldn't be authenticated

{
  "name": "pending",
  "url": "http://localhost:3000/pending",
  "defaultConfirmations": 0,
  "incomingToken": "543beda875ad415da60db7820faa4e83",
  "outgoingToken": "eb55bb6cfbb74fbe9972409fbd692449"
}

Path Params

:BridgeName
string
required
 
Suggest Edits

Bridge Type

 
gethttp://localhost:6688/v2/bridge_types/:BridgeName
curl -b cookiefile http://localhost:6688/v2/bridge_types/pending
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "bridges",
    "id": "pending",
    "attributes": {
      "name": "pending",
      "url": "http://localhost:3000/pending",
      "defaultConfirmations": 0,
      "incomingToken": "3d45b23676ce4a7ca2c6e87a87f3ae0c",
      "outgoingToken": "b7adbacda2dc47b3920d4957475fafde"
    }
  }
}
{
  "errors": [
    {
      "detail": "bridge name not found"
    }
  ]
}

Path Params

:BridgeName
string
required
 
Suggest Edits

Bridge Type

 
posthttp://localhost:6688/v2/bridge_types
curl -b cookiefile -X POST \
  -H 'Content-Type: application/json' \
  -d '{"name":"pending","url":"http://localhost:3000/pending"}' \
  http://localhost:6688/v2/bridge_types
A binary file was returned

You couldn't be authenticated

{
  "name": "pending",
  "url": "http://localhost:3000/pending",
  "defaultConfirmations": 0,
  "incomingToken": "3d45b23676ce4a7ca2c6e87a87f3ae0c",
  "outgoingToken": "b7adbacda2dc47b3920d4957475fafde"
}

Body Params

name
string
required
url
string
required
defaultConfirmations
int32
 
Suggest Edits

Bridge Types

 
gethttp://localhost:6688/v2/bridge_types
curl -b cookiefile http://localhost:6688/v2/bridge_types
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "type": "bridges",
      "id": "pending",
      "attributes": {
        "name": "pending",
        "url": "http://localhost:3000/pending",
        "defaultConfirmations": 0,
        "incomingToken": "3d45b23676ce4a7ca2c6e87a87f3ae0c",
        "outgoingToken": "b7adbacda2dc47b3920d4957475fafde"
      }
    }
  ],
  "meta": {
    "count": 1
  }
}
 
gethttp://localhost:6688/v2/config
curl -b cookiefile http://localhost:6688/v2/config
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "configWhitelists",
    "id": "77e33609e9be43e6afef295aa3360726",
    "attributes": {
      "allowOrigins": "*",
      "ethChainId": 3,
      "chainlinkDev": true,
      "clientNodeUrl": "http://localhost:6688",
      "databaseTimeout": "0s",
      "ethGasBumpThreshold": 12,
      "ethGasBumpWei": 5000000000,
      "ethGasPriceDefault": 20000000000,
      "ethUrl": "ws://localhost:8546",
      "linkContractAddress": "0x20fe562d797a42dcb3399062ae9546cd06f63280",
      "logLevel": "debug",
      "minIncomingConfirmations": 0,
      "minOutgoingConfirmations": 2,
      "minimumContractPayment": "1000000000000",
      "minimumRequestExpiration": 300,
      "oracleContractAddress": null,
      "chainlinkPort": "6688",
      "root": "/home/testuser/.ethereum"
    }
  }
}
 
Suggest Edits

Debug Vars

 
gethttp://localhost:6688/debug/vars
curl -b cookiefile http://localhost:6688/debug/vars
A binary file was returned

You couldn't be authenticated

{
"cmdline": ["chainlink","n","-p",".password"],
"memstats": {"Alloc":9220568,"TotalAlloc":408337256,"Sys":142670072,"Lookups":0,"Mallocs":3070872,"Frees":3053088,"HeapAlloc":9220568,"HeapSys":133136384,"HeapIdle":121913344,"HeapInuse":11223040,"HeapReleased":114991104,"HeapObjects":17784,"StackInuse":1081344,"StackSys":1081344,"MSpanInuse":72656,"MSpanSys":180224,"MCacheInuse":13824,"MCacheSys":16384,"BuckHashSys":1507660,"GCSys":4878336,"OtherSys":1869740,"NextGC":15541952,"LastGC":1538087520892214175,"PauseTotalNs":11604745,"PauseNs":[436491,44278,69808,86592,41648,61044,108796,173667,77976,31215,42569,78484,99754,41485,3357391,42869,63141,36715,39951,67379,242951,130730,30131,63998,78529,46337,69222,4443282,76249,38149,102145,34820,48088,77633,40726,84707,38979,62182,101851,162072,80121,76875,93200,74955,69833,55227,39093,141407,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"PauseEnd":[1538084690898139178,1538084690931713890,1538084690968439279,1538084690975987071,1538084691036629903,1538084691079458418,1538084691131854979,1538084691182647352,1538084691240529697,1538084691300584941,1538084691317908242,1538084691350414804,1538084691399150945,1538084691472816072,1538084732439401358,1538084814164578054,1538084868778972165,1538084914746698159,1538084961352365933,1538085085892037980,1538085184427629915,1538085255207369352,1538085321589676087,1538085401449363414,1538085497811300791,1538085607428662081,1538085683299100142,1538085735658341582,1538085842533487181,1538085924909399810,1538086029799462086,1538086145218349899,1538086265126298226,1538086295683968568,1538086415892025309,1538086525145623517,1538086561609443231,1538086685892571649,1538086810892202561,1538086822728419124,1538086892575439857,1538087004319341528,1538087125892543372,1538087250892233106,1538087319458890409,1538087360011467766,1538087399048723711,1538087520892214175,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"NumGC":48,"NumForcedGC":0,"GCCPUFraction":0.000006759356775635696,"EnableGC":true,"DebugGC":false,"BySize":[{"Size":0,"Mallocs":0,"Frees":0},{"Size":8,"Mallocs":12317,"Frees":10172},{"Size":16,"Mallocs":1303194,"Frees":1295153},{"Size":32,"Mallocs":554250,"Frees":551230},{"Size":48,"Mallocs":36499,"Frees":35274},{"Size":64,"Mallocs":23227,"Frees":22599},{"Size":80,"Mallocs":20236,"Frees":20072},{"Size":96,"Mallocs":13006,"Frees":12678},{"Size":112,"Mallocs":22470,"Frees":21830},{"Size":128,"Mallocs":2443,"Frees":2373},{"Size":144,"Mallocs":4287,"Frees":4204},{"Size":160,"Mallocs":25166,"Frees":24906},{"Size":176,"Mallocs":1409,"Frees":1351},{"Size":192,"Mallocs":5429,"Frees":5387},{"Size":208,"Mallocs":2359,"Frees":2265},{"Size":224,"Mallocs":509,"Frees":475},{"Size":240,"Mallocs":664,"Frees":638},{"Size":256,"Mallocs":7392,"Frees":7300},{"Size":288,"Mallocs":3655,"Frees":3559},{"Size":320,"Mallocs":3052,"Frees":3006},{"Size":352,"Mallocs":168,"Frees":128},{"Size":384,"Mallocs":3078,"Frees":2948},{"Size":416,"Mallocs":96,"Frees":55},{"Size":448,"Mallocs":84,"Frees":79},{"Size":480,"Mallocs":567,"Frees":562},{"Size":512,"Mallocs":307,"Frees":293},{"Size":576,"Mallocs":213,"Frees":199},{"Size":640,"Mallocs":439,"Frees":388},{"Size":704,"Mallocs":665,"Frees":655},{"Size":768,"Mallocs":404,"Frees":384},{"Size":896,"Mallocs":69,"Frees":35},{"Size":1024,"Mallocs":945,"Frees":920},{"Size":1152,"Mallocs":67,"Frees":54},{"Size":1280,"Mallocs":137,"Frees":114},{"Size":1408,"Mallocs":585,"Frees":575},{"Size":1536,"Mallocs":273,"Frees":269},{"Size":1792,"Mallocs":434,"Frees":419},{"Size":2048,"Mallocs":70,"Frees":64},{"Size":2304,"Mallocs":22,"Frees":16},{"Size":2688,"Mallocs":152,"Frees":134},{"Size":3072,"Mallocs":255,"Frees":250},{"Size":3200,"Mallocs":31,"Frees":29},{"Size":3456,"Mallocs":61,"Frees":56},{"Size":4096,"Mallocs":977,"Frees":914},{"Size":4864,"Mallocs":225,"Frees":211},{"Size":5376,"Mallocs":207,"Frees":190},{"Size":6144,"Mallocs":529,"Frees":517},{"Size":6528,"Mallocs":175,"Frees":168},{"Size":6784,"Mallocs":87,"Frees":85},{"Size":6912,"Mallocs":14,"Frees":13},{"Size":8192,"Mallocs":168,"Frees":164},{"Size":9472,"Mallocs":298,"Frees":289},{"Size":9728,"Mallocs":23,"Frees":23},{"Size":10240,"Mallocs":84,"Frees":83},{"Size":10880,"Mallocs":70,"Frees":62},{"Size":12288,"Mallocs":241,"Frees":240},{"Size":13568,"Mallocs":42,"Frees":41},{"Size":14336,"Mallocs":27,"Frees":26},{"Size":16384,"Mallocs":40,"Frees":40},{"Size":18432,"Mallocs":7,"Frees":6},{"Size":19072,"Mallocs":2,"Frees":1}]}
}
 
gethttp://localhost:6688/v2/runs/:RunID
curl -b cookiefile http://localhost:6688/v2/runs/91388f11e0fc4123870bda7128ce78a9
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "runs",
    "id": "91388f11e0fc4123870bda7128ce78a9",
    "attributes": {
      "id": "91388f11e0fc4123870bda7128ce78a9",
      "jobId": "819ad2084a144862b4c9ab71c9429e75",
      "result": {
        "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
        "data": {
          "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
        },
        "status": "completed",
        "error": null
      },
      "status": "completed",
      "taskRuns": [
        {
          "id": "be9aa2287a0541eab776b527dfe0da16",
          "result": {
            "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
            "data": {
              "value": "{\"USD\":280.77}"
            },
            "status": "completed",
            "error": null
          },
          "status": "completed",
          "task": {
            "confirmations": 0,
            "type": "httpget",
            "url": "https://min-api.cryptocompare.com/data/price?fsym=ETH&tsyms=USD"
          }
        },
        {
          "id": "907319bbc6c94313a193cc592ca5dfa1",
          "result": {
            "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
            "data": {
              "value": "280.77"
            },
            "status": "completed",
            "error": null
          },
          "status": "completed",
          "task": {
            "confirmations": 0,
            "path": [
              "USD"
            ],
            "type": "jsonparse"
          }
        },
        {
          "id": "3e466594d4dd481890a04e3284caffbd",
          "result": {
            "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
            "data": {
              "value": "28077"
            },
            "status": "completed",
            "error": null
          },
          "status": "completed",
          "task": {
            "confirmations": 0,
            "times": 100,
            "type": "multiply"
          }
        },
        {
          "id": "4f717b7705184078a25bf0fe0b166e50",
          "result": {
            "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
            "data": {
              "value": "0x3238303737000000000000000000000000000000000000000000000000000000"
            },
            "status": "completed",
            "error": null
          },
          "status": "completed",
          "task": {
            "confirmations": 0,
            "type": "ethbytes32"
          }
        },
        {
          "id": "4d04f2d2b39749b7bbec4eeab280523e",
          "result": {
            "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
            "data": {
              "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
            },
            "status": "completed",
            "error": null
          },
          "status": "completed",
          "task": {
            "address": "0x61f971debb1e46774074c03db9dc28650d31a151",
            "confirmations": 0,
            "functionSelector": "0xc2b12a73",
            "type": "ethtx",
            "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
          }
        }
      ],
      "createdAt": "2018-08-24T14:50:45.198480107-05:00",
      "completedAt": "2018-08-24T14:51:38.321011019-05:00",
      "creationHeight": "0x3b8ca0",
      "overrides": {
        "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
        "data": {
          "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
        },
        "status": "pending_confirmations",
        "error": null
      },
      "initiator": {
        "type": "web"
      }
    }
  }
}

Path Params

:RunID
string
required
 
patchhttp://localhost:6688/v2/runs/:RunID
curl -b cookiefile --request PATCH \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 3d45b23676ce4a7ca2c6e87a87f3ae0c' \
  -d '{"id":"25150bed88f640a288d47b043217a483","data":{"last":"1111"},"pending":false}' \
  http://localhost:6688/v2/runs/25150bed88f640a288d47b043217a483
A binary file was returned

You couldn't be authenticated

{"id":"25150bed88f640a288d47b043217a483"}
{
  "errors": [
    {
      "detail": "Incorrect access token for pending"
    }
  ]
}

Path Params

:RunID
string
required

Body Params

Authorization
string
required

The Incoming Token of the Bridge Type

id
string
required

The RunID to resume

data
object
required

The data object to pass into the run

pending
boolean

Include "pending":false to resume the job

 
posthttp://localhost:6688/v2/specs/:SpecID/runs
curl -b cookiefile -X POST http://localhost:6688/v2/specs/e67e84fa90f547a98f475c9c15850422/runs
A binary file was returned

You couldn't be authenticated

{"id":"29bfb58588364ca8977344777e98c195"}

Path Params

:SpecID
string
required
 
gethttp://localhost:6688/v2/specs/:SpecID/runs
curl -b cookiefile http://localhost:6688/v2/specs/819ad2084a144862b4c9ab71c9429e75/runs
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "type": "runs",
      "id": "91388f11e0fc4123870bda7128ce78a9",
      "attributes": {
        "id": "91388f11e0fc4123870bda7128ce78a9",
        "jobId": "819ad2084a144862b4c9ab71c9429e75",
        "result": {
          "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
          "data": {
            "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
          },
          "status": "pending_confirmations",
          "error": null
        },
        "status": "pending_confirmations",
        "taskRuns": [
          {
            "id": "be9aa2287a0541eab776b527dfe0da16",
            "result": {
              "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
              "data": {
                "value": "{\"USD\":280.77}"
              },
              "status": "completed",
              "error": null
            },
            "status": "completed",
            "task": {
              "confirmations": 0,
              "type": "httpget",
              "url": "https://min-api.cryptocompare.com/data/price?fsym=ETH&tsyms=USD"
            }
          },
          {
            "id": "907319bbc6c94313a193cc592ca5dfa1",
            "result": {
              "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
              "data": {
                "value": "280.77"
              },
              "status": "completed",
              "error": null
            },
            "status": "completed",
            "task": {
              "confirmations": 0,
              "path": [
                "USD"
              ],
              "type": "jsonparse"
            }
          },
          {
            "id": "3e466594d4dd481890a04e3284caffbd",
            "result": {
              "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
              "data": {
                "value": "28077"
              },
              "status": "completed",
              "error": null
            },
            "status": "completed",
            "task": {
              "confirmations": 0,
              "times": 100,
              "type": "multiply"
            }
          },
          {
            "id": "4f717b7705184078a25bf0fe0b166e50",
            "result": {
              "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
              "data": {
                "value": "0x3238303737000000000000000000000000000000000000000000000000000000"
              },
              "status": "completed",
              "error": null
            },
            "status": "completed",
            "task": {
              "confirmations": 0,
              "type": "ethbytes32"
            }
          },
          {
            "id": "4d04f2d2b39749b7bbec4eeab280523e",
            "result": {
              "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
              "data": {
                "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
              },
              "status": "pending_confirmations",
              "error": null
            },
            "status": "pending_confirmations",
            "task": {
              "address": "0x61f971debb1e46774074c03db9dc28650d31a151",
              "confirmations": 0,
              "functionSelector": "0xc2b12a73",
              "type": "ethtx",
              "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
            }
          }
        ],
        "createdAt": "2018-08-24T14:50:45.198480107-05:00",
        "completedAt": null,
        "initiator": {
          "id": 2,
          "jobId": "819ad2084a144862b4c9ab71c9429e75",
          "type": "web",
          "time": "0001-01-01T00:00:00Z",
          "address": "0x0000000000000000000000000000000000000000"
        },
        "creationHeight": "0x3b8ca0",
        "overrides": {
          "jobRunId": "91388f11e0fc4123870bda7128ce78a9",
          "data": {
            "value": "0x8f62a5662a653d370d34e079fd251bc924ad53dfd7e57c5da3ed27309fec31ef"
          },
          "status": "pending_confirmations",
          "error": null
        }
      }
    }
  ],
  "meta": {
    "count": 1
  }
}

Path Params

:SpecID
string
required
 
Suggest Edits

Service Agreements

 
gethttp://localhost:6688/v2/service_agreements/:SAID
curl -b cookiefile -H 'Content-Type: application/json' \
  http://localhost:6688/v2/service_agreements/0x959e90f2e5e1f708e68598d5dbdd5bcad05672779de80c2b6864dcf5d90a0bad
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "service_agreements",
    "id": "0x959e90f2e5e1f708e68598d5dbdd5bcad05672779de80c2b6864dcf5d90a0bad",
    "attributes": {
      "expiration": 300,
      "initiators": [
        {
          "type": "webx"
        }
      ],
      "oracles": [
        "0x3cb8e3FD9d27e39a5e9e6852b0e96160061fd4ea",
        "0x5958C587503b40A8576998dB56C3F5ec1f024C3D"
      ],
      "payment": "1000000000000000000",
      "tasks": [
        {
          "type": "HttpGet",
          "url": "https://bitstamp.net/api/ticker/"
        },
        {
          "path": [
            "last"
          ],
          "type": "JsonParse"
        },
        {
          "type": "EthBytes32"
        },
        {
          "type": "EthTx"
        }
      ]
    }
  }
}
{
  "errors": [
    {
      "detail": "ServiceAgreement not found"
    }
  ]
}

Path Params

:SAID
string
required
 
Suggest Edits

Service Agreements

 
posthttp://localhost:6688/v2/service_agreements
curl -b cookiefile -X POST \
  -H 'Content-Type: application/json' \
  -d '{"initiators":[{"type":"web"}],"tasks":[{"type":"HttpGet","url":"https://bitstamp.net/api/ticker/"},{"type":"JsonParse","path":["last"]},{"type":"EthBytes32"},{"type":"EthTx"}],"payment":"1000000000000000000","expiration":300,"oracles":["0x3cb8e3FD9d27e39a5e9e6852b0e96160061fd4ea","0x5958C587503b40A8576998dB56C3F5ec1f024C3D"]}' \
  http://localhost:6688/v2/service_agreements
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "service_agreements",
    "id": "0xa3b5d11c51d6bcebdd10a659b2b7bcb81d64f11e095283e6408b4015d3543b47",
    "attributes": {
      "createdAt": "2018-08-24T13:48:22.276976299-05:00",
      "encumbrance": {
        "payment": "1000000000000000000",
        "expiration": 300,
        "oracles": [
          "0x3cb8e3FD9d27e39a5e9e6852b0e96160061fd4ea",
          "0x5958C587503b40A8576998dB56C3F5ec1f024C3D"
        ]
      },
      "id": "0xa3b5d11c51d6bcebdd10a659b2b7bcb81d64f11e095283e6408b4015d3543b47",
      "jobSpecID": "3504d13b6ee5483aa1ec078123e715e0",
      "requestBody": "{\"expiration\":3.000000e+02,\"initiators\":[{\"type\":\"web\"}],\"oracles\":[\"0x3cb8e3FD9d27e39a5e9e6852b0e96160061fd4ea\",\"0x5958C587503b40A8576998dB56C3F5ec1f024C3D\"],\"payment\":\"1000000000000000000\",\"tasks\":[{\"type\":\"HttpGet\",\"url\":\"https://bitstamp.net/api/ticker/\"},{\"path\":[\"last\"],\"type\":\"JsonParse\"},{\"type\":\"EthBytes32\"},{\"type\":\"EthTx\"}]}",
      "signature": "0x6a43948ea2d0a4c449fac0f1b36925dc187322a94eccb7791999faed43234f89798c0f25f44e5c8fb2896ba8547ffd5c363962327b4dd02aee4f4771bb6e00ed01"
    }
  }
}
{
  "errors": [
    {
      "detail": "Service agreement encumbrance error: This node must be listed in the participating oracles"
    }
  ]
}
{
  "errors": [
    {
      "detail": "Service agreement encumbrance error: Payment amount is below minimum 0.000001000000000000"
    }
  ]
}

Body Params

initiators
array
required
tasks
array
required
payment
string
required
expiration
int32
required
oracles
array of strings
required
 
 
deletehttp://localhost:6688/sessions
curl -b cookiefile -X DELETE http://localhost:6688/sessions
A binary file was returned

You couldn't be authenticated

{"authenticated":false}
 
 
posthttp://localhost:6688/sessions
curl -c cookiefile \
  -d '{"email":"[email protected]", "password":"password"}' \
  -X POST -H 'Content-Type: application/json' \
   http://localhost:6688/sessions
A binary file was returned

You couldn't be authenticated

{"authenticated":true}
{"errors":["Invalid password"]}

Body Params

email
string
required

The API Email used for authentication.

password
string
required

The API Password used for authentication.

 
 
gethttp://localhost:6688/v1/snapshots/:ID
curl -b cookiefile http://localhost:6688/v1/snapshots/891908d7fb7440c2847ad083e2a314ed
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

:ID
string
required

The Snapshot ID

 
 
posthttp://localhost:6688/v1/assignments/:AID/snapshots
curl -b cookiefile -X POST http://localhost:6688/v1/assignments/794d7c4b032f4e6c91ba9adea1c77626/snapshots
A binary file was returned

You couldn't be authenticated

{"id":"891908d7fb7440c2847ad083e2a314ed"}
{
  "errors": [
    {
      "detail": "Job not found"
    }
  ]
}

Path Params

:AID
string
required

The Assignment ID

 
gethttp://localhost:6688/v2/specs/:SpecID
curl -b cookiefile http://localhost:6688/v2/specs/e67e84fa90f547a98f475c9c15850422
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "type": "specs",
    "id": "e67e84fa90f547a98f475c9c15850422",
    "attributes": {
      "initiators": [
        {
          "type": "web"
        }
      ],
      "id": "e67e84fa90f547a98f475c9c15850422",
      "createdAt": "2018-08-24T19:37:29.99742431Z",
      "tasks": [
        {
          "confirmations": 0,
          "type": "httpget"
        },
        {
          "confirmations": 0,
          "type": "jsonparse"
        },
        {
          "confirmations": 0,
          "type": "multiply"
        },
        {
          "confirmations": 0,
          "type": "ethuint256"
        },
        {
          "confirmations": 0,
          "type": "ethtx"
        }
      ],
      "startAt": null,
      "endAt": null
    }
  }
}

Path Params

:SpecID
string
required
 
posthttp://localhost:6688/v2/specs
curl  -b cookiefile -X POST \
  -H 'Content-Type: application/json' \
  -d '{"initiators":[{"type":"web"}],"tasks":[{"type":"httpget"},{"type":"jsonparse"},{"type":"multiply"},{"type":"ethuint256"},{"type":"ethtx"}]}' \
  http://localhost:6688/v2/specs
A binary file was returned

You couldn't be authenticated

{
  "initiators": [
    {
      "type": "web"
    }
  ],
  "id": "e67e84fa90f547a98f475c9c15850422",
  "createdAt": "2018-08-24T14:37:29.99742431-05:00",
  "tasks": [
    {
      "confirmations": 0,
      "type": "httpget"
    },
    {
      "confirmations": 0,
      "type": "jsonparse"
    },
    {
      "confirmations": 0,
      "type": "multiply"
    },
    {
      "confirmations": 0,
      "type": "ethuint256"
    },
    {
      "confirmations": 0,
      "type": "ethtx"
    }
  ],
  "startAt": null,
  "endAt": null
}

Body Params

initiators
array
required
tasks
array
required
 
gethttp://localhost:6688/v2/specs/
curl -b cookiefile http://localhost:6688/v2/specs
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "type": "specs",
      "id": "e67e84fa90f547a98f475c9c15850422",
      "attributes": {
        "initiators": [
          {
            "type": "web"
          }
        ],
        "id": "e67e84fa90f547a98f475c9c15850422",
        "createdAt": "2018-08-24T19:37:29.99742431Z",
        "tasks": [
          {
            "confirmations": 0,
            "type": "httpget"
          },
          {
            "confirmations": 0,
            "type": "jsonparse"
          },
          {
            "confirmations": 0,
            "type": "multiply"
          },
          {
            "confirmations": 0,
            "type": "ethuint256"
          },
          {
            "confirmations": 0,
            "type": "ethtx"
          }
        ],
        "startAt": null,
        "endAt": null
      }
    }
  ],
  "meta": {
    "count": 1
  }
}