Get File Upload URL (Legacy)
curl --request POST \
--url https://api.royalti.io/file/getUploadUrl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"royaltySource": "testsource",
"accountingPeriod": "2017-05-01",
"salePeriod": "2017-01-01",
"fileMetaData": {
"uploadType": "royalty",
"originalname": "export.csv",
"mimetype": "csv"
}
}
'import requests
url = "https://api.royalti.io/file/getUploadUrl"
payload = {
"royaltySource": "testsource",
"accountingPeriod": "2017-05-01",
"salePeriod": "2017-01-01",
"fileMetaData": {
"uploadType": "royalty",
"originalname": "export.csv",
"mimetype": "csv"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
royaltySource: 'testsource',
accountingPeriod: '2017-05-01',
salePeriod: '2017-01-01',
fileMetaData: {uploadType: 'royalty', originalname: 'export.csv', mimetype: 'csv'}
})
};
fetch('https://api.royalti.io/file/getUploadUrl', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/file/getUploadUrl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'royaltySource' => 'testsource',
'accountingPeriod' => '2017-05-01',
'salePeriod' => '2017-01-01',
'fileMetaData' => [
'uploadType' => 'royalty',
'originalname' => 'export.csv',
'mimetype' => 'csv'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/file/getUploadUrl"
payload := strings.NewReader("{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.royalti.io/file/getUploadUrl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/file/getUploadUrl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}"
response = http.request(request)
puts response.read_body{
"signedUrl": "https://storage.googleapis.com/royalti-uploads/royalty/file-uuid-123?signature=..."
}{
"status": "error",
"message": "Invalid request parameters"
}{
"status": "error",
"message": "Unauthorized"
}{
"status": "error",
"message": "Internal server error"
}File
Get File Upload URL (Legacy)
deprecated
DEPRECATED: This endpoint is deprecated and will be removed in a future version.
POST
/
file
/
getUploadUrl
Get File Upload URL (Legacy)
curl --request POST \
--url https://api.royalti.io/file/getUploadUrl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"royaltySource": "testsource",
"accountingPeriod": "2017-05-01",
"salePeriod": "2017-01-01",
"fileMetaData": {
"uploadType": "royalty",
"originalname": "export.csv",
"mimetype": "csv"
}
}
'import requests
url = "https://api.royalti.io/file/getUploadUrl"
payload = {
"royaltySource": "testsource",
"accountingPeriod": "2017-05-01",
"salePeriod": "2017-01-01",
"fileMetaData": {
"uploadType": "royalty",
"originalname": "export.csv",
"mimetype": "csv"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
royaltySource: 'testsource',
accountingPeriod: '2017-05-01',
salePeriod: '2017-01-01',
fileMetaData: {uploadType: 'royalty', originalname: 'export.csv', mimetype: 'csv'}
})
};
fetch('https://api.royalti.io/file/getUploadUrl', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/file/getUploadUrl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'royaltySource' => 'testsource',
'accountingPeriod' => '2017-05-01',
'salePeriod' => '2017-01-01',
'fileMetaData' => [
'uploadType' => 'royalty',
'originalname' => 'export.csv',
'mimetype' => 'csv'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/file/getUploadUrl"
payload := strings.NewReader("{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.royalti.io/file/getUploadUrl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/file/getUploadUrl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"royaltySource\": \"testsource\",\n \"accountingPeriod\": \"2017-05-01\",\n \"salePeriod\": \"2017-01-01\",\n \"fileMetaData\": {\n \"uploadType\": \"royalty\",\n \"originalname\": \"export.csv\",\n \"mimetype\": \"csv\"\n }\n}"
response = http.request(request)
puts response.read_body{
"signedUrl": "https://storage.googleapis.com/royalti-uploads/royalty/file-uuid-123?signature=..."
}{
"status": "error",
"message": "Invalid request parameters"
}{
"status": "error",
"message": "Unauthorized"
}{
"status": "error",
"message": "Internal server error"
}This endpoint requires authentication. Include your Bearer token in the Authorization header.
Description
Please use/file/upload-url instead, which provides:
- Auto-detection of royalty source and period
- Pre-upload analysis with confidence scores
- Support for ZIP files with multiple royalty files
- Better error handling and validation
- Required role:
useror higher
Code Examples
const response = await fetch('https://api.royalti.io/file/getUploadUrl', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"royaltySource": "sample-royaltySource",
"accountingPeriod": "2024-01-21",
"salePeriod": "2024-01-21",
"fileMetaData": {}
})
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
'https://api.royalti.io/file/getUploadUrl',
headers={
'Authorization': f'Bearer {token}'
},
json={"royaltySource":"sample-royaltySource","accountingPeriod":"2024-01-21","salePeriod":"2024-01-21","fileMetaData":{}}
)
data = response.json()
print(data)
curl -X POST https://api.royalti.io/file/getUploadUrl \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"royaltySource":"sample-royaltySource","accountingPeriod":"2024-01-21","salePeriod":"2024-01-21","fileMetaData":{}}'
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
Response
Signed upload URL generated.
⌘I