Show Study cost | Prolific API

Returns cost information about the study. Default behaviour is to return cost at the time of the request, but projected cost can be requested via a query parameter.

Authentication

Authorizationstring

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Path Parameters

idstringRequired

Study id

Query Parameters

is_projectedbooleanOptionalDefaults to false

Return the projected cost of the study

Response

Return the total cost for the study

rewardsobject or null

bonusesobject or null

_linksmap from strings to any or null

1	import requests
2
3	url = "https://api.prolific.com/api/v1/studies/id/cost/"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"rewards": {
3	"rewards": {
4	"amount": 100,
5	"currency": "USD"
6	},
7	"fees": {
8	"amount": 100,
9	"currency": "USD"
10	},
11	"tax": {
12	"amount": 100,
13	"currency": "USD"
14	}
15	},
16	"bonuses": {
17	"rewards": {
18	"amount": 100,
19	"currency": "USD"
20	},
21	"fees": {
22	"amount": 100,
23	"currency": "USD"
24	},
25	"tax": {
26	"amount": 100,
27	"currency": "USD"
28	}
29	},
30	"_links": {}
31	}

Authentication

Path Parameters

Query Parameters

Response

Errors