Orthanc API
orthanc-server · Company
This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc. This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book. An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEI
Authentication
Sample Requests
Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes Log_. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, th
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes?limit=10&since=1"
import requests
params = {
"limit": "10",
"since": "1"
}
response = requests.get(
"https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes');
url.searchParams.set('limit', '10');
url.searchParams.set('since', '1');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes")
q := baseURL.Query()
q.Set("limit", "10")
q.Set("since", "1")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes")
uri.query = URI.encode_www_form({
"limit" => "10",
"since" => "1"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/changes?" . http_build_query([
"limit" => "10",
"since" => "1"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting t
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports?limit=10&since=1"
import requests
params = {
"limit": "10",
"since": "1"
}
response = requests.get(
"https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports');
url.searchParams.set('limit', '10');
url.searchParams.set('since', '1');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports")
q := baseURL.Query()
q.Set("limit", "10")
q.Set("since", "1")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports")
uri.query = URI.encode_www_form({
"limit" => "10",
"since" => "1"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/exports?" . http_build_query([
"limit" => "10",
"since" => "1"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List the Orthanc identifiers of all the available DICOM instances
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances?full=true&limit=10&short=true&since=1&expand=example&requestedTags=example"
import requests
params = {
"full": "true",
"limit": "10",
"short": "true",
"since": "1",
"expand": "example",
"requestedTags": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances');
url.searchParams.set('full', 'true');
url.searchParams.set('limit', '10');
url.searchParams.set('short', 'true');
url.searchParams.set('since', '1');
url.searchParams.set('expand', 'example');
url.searchParams.set('requestedTags', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances")
q := baseURL.Query()
q.Set("full", "true")
q.Set("limit", "10")
q.Set("short", "true")
q.Set("since", "1")
q.Set("expand", "example")
q.Set("requestedTags", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances")
uri.query = URI.encode_www_form({
"full" => "true",
"limit" => "10",
"short" => "true",
"since" => "1",
"expand" => "example",
"requestedTags" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/orthanc-server.com/1.11.3/instances?" . http_build_query([
"full" => "true",
"limit" => "10",
"short" => "true",
"since" => "1",
"expand" => "example",
"requestedTags" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Orthanc API?
Orthanc API is a Company API. Developers commonly use company APIs for:
- enriching CRM records with company firmographics
- building lead-generation and prospecting tools
- verifying business identity and registration details
- monitoring competitors and market intelligence
- powering B2B data enrichment pipelines
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Orthanc API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?